doc: clarify documentation in crypto #16229
Closed
Conversation
This file contains 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
Clarify on the return values for crypto.publicEncrypt and similar functions Fixes: nodejs#12946
nodejs-github-bot
added
crypto
joyeecheung
approved these changes
Oct 16, 2017
doc/api/crypto.md
Outdated
| @@ -1687,12 +1687,15 @@ added: v0.11.14 | |||
| `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`, | |||
| `RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. | |||
| - `buffer` {Buffer | TypedArray | DataView} | |||
| - Returns: {Buffer} | |||
There was a problem hiding this comment.
Maybe we can just put the description on the list?
- Returns: {Buffer} A new `Buffer` with the decrypted content.
There was a problem hiding this comment.
Right. I was taking reference from https://github.com/nodejs/node/blob/master/doc/api/buffer.md#bufequalsotherbuffer, where we specify a return type in the list and additional description in the later paragraph.
I realised this is actually a little inconsistent, the next function is documented as you have suggested above. I'll add a commit to clean this up, and implement your suggestion.
gireeshpunathil
approved these changes
Oct 16, 2017
lpinca
approved these changes
Oct 16, 2017
cjihrig
approved these changes
Oct 16, 2017
jasnell
approved these changes
Oct 16, 2017
|
CI looks fine modulo a couple of known-to-be-flakey tests. |
|
Landed in a3a1068 Thanks for the contribution! 🥇 |
lance
pushed a commit
that referenced
this pull request
Oct 16, 2017
Clarify return values for crypto.publicEncrypt and similar functions PR-URL: #16229 Fixes: #12946 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
targos
pushed a commit
that referenced
this pull request
Oct 18, 2017
Clarify return values for crypto.publicEncrypt and similar functions PR-URL: #16229 Fixes: #12946 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
addaleax
pushed a commit
to ayojs/ayo
that referenced
this pull request
Oct 18, 2017
Clarify return values for crypto.publicEncrypt and similar functions PR-URL: nodejs/node#16229 Fixes: nodejs/node#12946 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
|
Should this be backported to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify on the return values for crypto.publicEncrypt and similar functions
Fixes: #12946
Checklist
Affected core subsystem(s)