FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: remove generated from dsaEncoding description by kaznovac · Pull Request #37459 · nodejs/node · GitHub

/ node Public

doc: remove generated from dsaEncoding description - #37459

Closed
kaznovac wants to merge 2 commits into
nodejs:masterfrom
kaznovac:patch-1
ConversationCommits (2)ChecksFiles changed
Closed

doc: remove generated from dsaEncoding description#37459
kaznovac wants to merge 2 commits into
nodejs:masterfrom
kaznovac:patch-1

Conversation

kaznovac commented Feb 20, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

remove term generated from dsaEncoding parameter's description - the parameter is used to specify the format of the signature, function dictates the signature 'action'

Fixes: #37454

nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Feb 20, 2021
Trott approved these changes Feb 21, 2021
View reviewed changes

Trott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM. Can you fix the typographical error (generted->generated) in the commit message?

mscdex reviewed Feb 21, 2021
View reviewed changes
Comment thread doc/api/crypto.md Outdated
mscdex reviewed Feb 21, 2021
View reviewed changes
Comment thread doc/api/crypto.md Outdated
doc: remove generated from dsaEncoding description
33739b8 
remove term `generated` from `dsaEncoding` parameter's description - the parameter is used to specify the format of the signature, function dictates the signature 'action'
kaznovac changed the title doc: remove generted from dsaEncoding description doc: remove generated from dsaEncoding description Feb 21, 2021

kaznovac commented Feb 21, 2021

Copy link
Copy Markdown
Contributor Author

@Trott @mscdex thank you both for the review

@Trott i've fixed typo in the commit message

@mscdex my rationale is that dsaEncoding parameter does not influence the action (generate or validate) taken on the signature, but the signature's format; i find it surplus to describe the origin of the signature on the parameter (feels like breaking DRY principle)... if this sounds wrong to you, please respond and i'll revert those two lines.

jasnell requested changes Feb 23, 2021
View reviewed changes

jasnell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I agree with @mscdex's feedback. Several of the 'generated' uses are appropriate.

tniessen commented Feb 23, 2021

Copy link
Copy Markdown
Member

I probably wrote these descriptions. I agree with @mscdex, but I don't feel strongly about it.

i find it surplus to describe the origin of the signature on the parameter (feels like breaking DRY principle)

Following this argument, I guess just having documentation breaks DRY. Just look at the code instead, it has all the information 😉

restore generated term for the sign actions
9df1e44 
Co-authored-by: mscdex <mscdex@users.noreply.github.com>
kaznovac requested review from jasnell and mscdex February 24, 2021 12:18

kaznovac commented Feb 24, 2021

Copy link
Copy Markdown
Contributor Author

@jasnell @tniessen thanks for the additional review

@jasnell @mscdex suggested changes applied

@tniessen yes, i agree DRY principle can be overly extended; however this is not the case as the documentation is about why/what, and code is about how ;)

jasnell pushed a commit that referenced this pull request Mar 9, 2021
doc: remove generated from dsaEncoding description
4947ce5 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

jasnell commented Mar 9, 2021

Copy link
Copy Markdown
Member

Landed in 4947ce5

jasnell closed this Mar 9, 2021
kaznovac deleted the patch-1 branch March 9, 2021 20:55
danielleadams pushed a commit that referenced this pull request Mar 16, 2021
doc: remove generated from dsaEncoding description
6192315 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
danielleadams mentioned this pull request Mar 16, 2021
Merged
targos pushed a commit that referenced this pull request May 27, 2021
doc: remove generated from dsaEncoding description
c95846d 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request May 30, 2021
doc: remove generated from dsaEncoding description
7c66142 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jun 5, 2021
doc: remove generated from dsaEncoding description
0d2704f 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos mentioned this pull request Jun 6, 2021
Merged
targos pushed a commit that referenced this pull request Jun 11, 2021
doc: remove generated from dsaEncoding description
a6c1233 
remove term `generated` from `dsaEncoding` parameter's description -
the parameter is used to specify the format of the signature,
function dictates the signature 'action'

PR-URL: #37459
Fixes: #37454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This was referenced Apr 18, 2023
Open
Open
137717unity mentioned this pull request Apr 18, 2023
Open
wedataintelligence mentioned this pull request Apr 18, 2023
Open
This was referenced Apr 19, 2023
Open
Open
ron-a20 mentioned this pull request Apr 19, 2023
Open
snyk-bot mentioned this pull request Apr 19, 2023
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
Trott Trott approved these changes
marsonya marsonya approved these changes
mscdex Awaiting requested review from mscdex

Assignees

No one assigned

Labels

crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: bad crypto.verify() dsaEncoding description

7 participants

Back | FazBrowse Home | New Git URL