-
-
Notifications
You must be signed in to change notification settings - Fork 31.5k
doc: Update doc of publicEncrypt method #12947
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
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.
Nit: could you limit the line length to 80 characters so that is consistent?
Yupp |
doc/api/crypto.md
Outdated
@@ -1665,7 +1665,8 @@ added: v0.11.14 | |||
`RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. | |||
- `buffer` {Buffer | TypedArray | DataView} | |||
|
|||
Encrypts `buffer` with `public_key`. | |||
Encrypts the content of `buffer` with `public_key` and returns a new | |||
buffer with encrypted content. |
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.
s/buffer/[`Buffer`][]/
While you're in there, would you mind changing |
As per nodejs#12946 the crypto doc for publicEncrypt doesn't tell you whether the encryption happens in place or not.
done & done @mscdex |
LGTM |
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
Landed in eff9252 |
As per #12946 the crypto doc for publicEncrypt doesn't tell you whether the encryption happens in place or not. Fixes: #12946 PR-URL: #12947 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
As per nodejs#12946 the crypto doc for publicEncrypt doesn't tell you whether the encryption happens in place or not. Fixes: nodejs#12946 PR-URL: nodejs#12947 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
v6.x? |
As per #12946
the crypto doc for
publicEncrypt
doesn't tellyou whether the encryption happens in place or not.
Checklist
Affected core subsystem(s)
doc