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: make constants enumeration consistent #20991

Closed
wants to merge 2 commits into from
Closed

doc: make constants enumeration consistent #20991

wants to merge 2 commits into from

Conversation

DiegoRBaquero
Copy link
Contributor

Add missing prefix crypto.constants. to RSA_PKCS1_PADDING in crypto.privateEncrypt(), crypto.privateDecrypt(), crypto.publicEncrypt() and crypto.publicDecrypt()

Checklist
  • documentation is changed or added
  • commit message follows [commit guidelines]

@DiegoRBaquero
doc: make constants enumeration consistent
55dcde5 
Add missing prefix `crypto.constants.` to `RSA_PKCS1_PADDING` in crypto.privateEncrypt(), crypto.privateDecrypt(), crypto.publicEncrypt() and crypto.publicDecrypt()
@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 May 28, 2018
@starkwang
Copy link
Contributor

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

Trott
Trott reviewed May 28, 2018
View reviewed changes
doc/api/crypto.md Outdated
@@ -1959,7 +1959,7 @@ added: v0.11.14
- `passphrase` {string} An optional passphrase for the private key.
- `padding` {crypto.constants} An optional padding value defined in
`crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`,
`RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`.
`crypto.constants.RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`.
Copy link
Member

Choose a reason for hiding this comment

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

Wrap at 80 chars?

Copy link
Member

Choose a reason for hiding this comment

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

(Looks like the linter complained about this and the other one. After changing docs, it's a good idea to run make lint-md if you're not on Windows so that you can get notified of these things.)

Trott
Trott reviewed May 28, 2018
View reviewed changes
doc/api/crypto.md Outdated
@@ -1902,7 +1902,7 @@ added: v0.11.14
- `passphrase` {string} An optional passphrase for the private key.
- `padding` {crypto.constants} An optional padding value defined in
`crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`,
`RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`.
`crypto.constants.RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`.
Copy link
Member

Choose a reason for hiding this comment

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

Wrap at 80 chars?

@DiegoRBaquero
doc: wrap padding options at 80 characters
9304fa5 
Wrap padding options text at 80 characters to match linter rules
@DiegoRBaquero
Copy link
Contributor Author

Wrapped text, sorry about that.

@BridgeAR
Copy link
Member

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

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 28, 2018
@vsemozhetbyt
Copy link
Contributor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label May 29, 2018
@vsemozhetbyt
Copy link
Contributor

Landed in 62c8fb3
Thank you!

vsemozhetbyt pushed a commit that referenced this pull request May 29, 2018
@DiegoRBaquero @vsemozhetbyt
doc: make constants enumeration consistent
62c8fb3 
Add missing prefix `crypto.constants.` to `RSA_PKCS1_PADDING`
in `crypto.privateEncrypt()`, `crypto.privateDecrypt()`,
`crypto.publicEncrypt()`, and `crypto.publicDecrypt()`.

PR-URL: #20991
Reviewed-By: Weijia Wang <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
@DiegoRBaquero DiegoRBaquero deleted the patch-1 branch May 30, 2018 00:49
addaleax pushed a commit that referenced this pull request May 31, 2018
@DiegoRBaquero @addaleax
doc: make constants enumeration consistent
ab43581 
Add missing prefix `crypto.constants.` to `RSA_PKCS1_PADDING`
in `crypto.privateEncrypt()`, `crypto.privateDecrypt()`,
`crypto.publicEncrypt()`, and `crypto.publicDecrypt()`.

PR-URL: #20991
Reviewed-By: Weijia Wang <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jun 6, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@trivikr trivikr trivikr approved these changes

@starkwang starkwang starkwang approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca 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. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@DiegoRBaquero @starkwang @BridgeAR @vsemozhetbyt @Trott @lpinca @cjihrig @trivikr @nodejs-github-bot