Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: remove generated from dsaEncoding description #37459

Closed
wants to merge 2 commits into from

Conversation

kaznovac
Copy link
Contributor

@kaznovac kaznovac commented Feb 20, 2021

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 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
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

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

doc/api/crypto.md Outdated Show resolved Hide resolved
doc/api/crypto.md Outdated Show resolved Hide resolved
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 kaznovac changed the title doc: remove generted from dsaEncoding description doc: remove generated from dsaEncoding description Feb 21, 2021
@kaznovac
Copy link
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.

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

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

@tniessen
Copy link
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 😉

Co-authored-by: mscdex <mscdex@users.noreply.github.com>
@kaznovac
Copy link
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
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
Copy link
Member

jasnell commented Mar 9, 2021

Landed in 4947ce5

@jasnell jasnell closed this Mar 9, 2021
@kaznovac kaznovac deleted the patch-1 branch March 9, 2021 20:55
danielleadams pushed a commit that referenced this pull request Mar 16, 2021
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 27, 2021
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
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
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 11, 2021
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: bad crypto.verify() dsaEncoding description
7 participants