-
Notifications
You must be signed in to change notification settings - Fork 30.7k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
doc: remove generated from dsaEncoding description #37459
Conversation
There was a problem hiding this 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?
remove term `generated` from `dsaEncoding` parameter's description - the parameter is used to specify the format of the signature, function dictates the signature 'action'
@Trott @mscdex thank you both for the review @Trott i've fixed typo in the commit message @mscdex my rationale is that |
There was a problem hiding this 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.
I probably wrote these descriptions. I agree with @mscdex, but I don't feel strongly about it.
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>
Landed in 4947ce5 |
remove term
generated
fromdsaEncoding
parameter's description - the parameter is used to specify the format of the signature, function dictates the signature 'action'Fixes: #37454