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.

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

doc: Update doc of publicEncrypt method #12947

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
10 participants
@fhalde
Contributor

fhalde commented May 10, 2017

As per #12946
the crypto doc for publicEncrypt doesn't tell
you whether the encryption happens in place or not.

Checklist
Affected core subsystem(s)

doc

@danbev

danbev approved these changes May 10, 2017

Nit: could you limit the line length to 80 characters so that is consistent?

@fhalde

This comment has been minimized.

Show comment
Hide comment
@fhalde

fhalde May 10, 2017

Contributor

Yupp

Contributor

fhalde commented May 10, 2017

Yupp

Show outdated Hide outdated doc/api/crypto.md
@@ -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.

This comment has been minimized.

@mscdex

mscdex May 10, 2017

Contributor

s/buffer/[`Buffer`][]/

@mscdex

mscdex May 10, 2017

Contributor

s/buffer/[`Buffer`][]/

@mscdex

This comment has been minimized.

Show comment
Hide comment
@mscdex

mscdex May 10, 2017

Contributor

While you're in there, would you mind changing private_key to public_key in both of the public*() method parameter descriptions?

Contributor

mscdex commented May 10, 2017

While you're in there, would you mind changing private_key to public_key in both of the public*() method parameter descriptions?

doc: Update doc of publicEncrypt method
As per #12946
the crypto doc for publicEncrypt doesn't tell
you whether the encryption happens in place or not.
@fhalde

This comment has been minimized.

Show comment
Hide comment
@fhalde

fhalde May 10, 2017

Contributor

done & done @mscdex

Contributor

fhalde commented May 10, 2017

done & done @mscdex

@lpinca

lpinca approved these changes May 10, 2017

@mscdex

This comment has been minimized.

Show comment
Hide comment
@mscdex

mscdex May 10, 2017

Contributor

LGTM

Contributor

mscdex commented May 10, 2017

LGTM

@mhdawson

LGTM

@addaleax

This comment has been minimized.

Show comment
Hide comment
@addaleax

addaleax May 19, 2017

Member

Landed in eff9252

Member

addaleax commented May 19, 2017

Landed in eff9252

@addaleax addaleax closed this May 19, 2017

addaleax added a commit that referenced this pull request May 19, 2017

doc: update doc of publicEncrypt method
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>

anchnk added a commit to anchnk/node that referenced this pull request May 19, 2017

doc: update doc of publicEncrypt method
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>

@jasnell jasnell referenced this pull request May 28, 2017

Closed

8.0.0 Release Proposal #12220

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete
@MylesBorins

This comment has been minimized.

Show comment
Hide comment
@MylesBorins

MylesBorins Jul 17, 2017

Member

v6.x?

Member

MylesBorins commented Jul 17, 2017

v6.x?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment