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.

Sign up for GitHub

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

Jump to bottom

doc: add missing options for crypto sign.sign() #22824

Closed
wants to merge 1 commit into from
Closed

doc: add missing options for crypto sign.sign() #22824

wants to merge 1 commit into from

Conversation

mbj36
Copy link
Contributor

@mbj36 mbj36 commented Sep 12, 2018 •
edited
Loading

Fixes #22813

Checklist

@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 Sep 12, 2018
@vsemozhetbyt
Copy link
Contributor

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/867/

сс @nodejs/crypto

@tniessen tniessen added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 12, 2018
Trott
Trott reviewed Sep 13, 2018
View reviewed changes
doc/api/crypto.md
@@ -1121,6 +1121,8 @@ changes:
* `privateKey` {string | Object}
- `key` {string}
- `passphrase` {string}
- `padding` {integer}
Copy link
Member

Choose a reason for hiding this comment

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

I know it seems sensible to keep key and passphrase near each other, but I wonder if we would be best to alphabetize the options always. Especially in crypto, the options lists can get long and having a clear and obvious ordering is helpful when you're looking for that one option you care about.

Copy link
Contributor

Choose a reason for hiding this comment

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

Discussion: #22874

@vsemozhetbyt vsemozhetbyt mentioned this pull request Sep 15, 2018
Closed
@targos
Copy link
Member

targos commented Sep 17, 2018

Landed in cb3d6d5.
Thank you @mbj36!

@targos targos closed this Sep 17, 2018
targos pushed a commit that referenced this pull request Sep 17, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
cb3d6d5 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
targos pushed a commit that referenced this pull request Sep 18, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
b1473c7 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@targos targos mentioned this pull request Sep 18, 2018
Merged
targos pushed a commit that referenced this pull request Sep 19, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
dfef9a9 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
targos pushed a commit that referenced this pull request Sep 20, 2018
@mbj36 @targos
doc: add missing options for crypto sign.sign()
0873d0a 
Fixes: #22813

PR-URL: #22824
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsemozhetbyt vsemozhetbyt vsemozhetbyt left review comments

@Trott Trott Trott left review comments

@richardlau richardlau richardlau approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. 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: crypto sign.sign() signature description missing options
9 participants
@mbj36 @vsemozhetbyt @targos @jasnell @Trott @lpinca @richardlau @tniessen @nodejs-github-bot