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 and unify return statements in crypto.md #19853

Closed
wants to merge 3 commits into from
Closed

doc: add and unify return statements in crypto.md #19853

wants to merge 3 commits into from

Conversation

vsemozhetbyt
Copy link
Contributor

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Conform return statements to the style guide and tool parsers.

Also bring back a description fragment that seems to be erroneously deleted in
1e07acd (cc @tniessen)

@vsemozhetbyt
doc: add and unify return statements in crypto.md
5a92fcc 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
1e07acd
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Apr 6, 2018
@vsemozhetbyt vsemozhetbyt added the crypto Issues and PRs related to the crypto subsystem. label Apr 6, 2018
@vsemozhetbyt
Copy link
Contributor Author

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

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 6, 2018
Trott
Trott approved these changes Apr 6, 2018
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

Rubber-stamp LGTM if CI is green.

@Trott
Copy link
Member

Trott commented Apr 6, 2018

@nodejs/documentation

@Trott
Copy link
Member

Trott commented Apr 6, 2018

@nodejs/crypto

lpinca
lpinca approved these changes Apr 7, 2018
View reviewed changes
doc/api/crypto.md Outdated
@@ -1232,6 +1244,9 @@ changes:
- `object` {string | Object}
- `signature` {string | Buffer | TypedArray | DataView}
- `signatureFormat` {string}
- Returns: {boolean} `true` or `false` depending on the validity of the
signature for the data and public key.

Copy link
Member

Choose a reason for hiding this comment

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

Nit: Spurious new line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

BridgeAR
BridgeAR approved these changes Apr 8, 2018
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

LGTM but I did not check if the added return types are correct.

doc/api/crypto.md Show resolved Hide resolved
@BridgeAR BridgeAR added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 8, 2018
@vsemozhetbyt
Copy link
Contributor Author

@nodejs/crypto can somebody confirm that added return types are correct?

tniessen
tniessen approved these changes Apr 8, 2018
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

@vsemozhetbyt I believe they are.

doc/api/crypto.md Outdated

Returns the EC Diffie-Hellman public key in the specified `encoding` and
`format`.
- Returns: {Buffer | string} the EC Diffie-Hellman public key in the specified
Copy link
Member

Choose a reason for hiding this comment

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

Uppercase for consistency? {Buffer | string} The

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in the fixup commit.

@vsemozhetbyt
Copy link
Contributor Author

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/453/
Will land soon if nobody objects.

vsemozhetbyt added a commit that referenced this pull request Apr 8, 2018
@vsemozhetbyt
doc: add and unify return statements in crypto.md
0bd3da1 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
1e07acd

PR-URL: #19853
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@vsemozhetbyt
Copy link
Contributor Author

Landed in 0bd3da1

@vsemozhetbyt vsemozhetbyt deleted the doc-crypto-nits branch April 8, 2018 22:23
targos pushed a commit that referenced this pull request Apr 12, 2018
@vsemozhetbyt @targos
doc: add and unify return statements in crypto.md
ec37e66 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
1e07acd

PR-URL: #19853
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 1, 2018
@vsemozhetbyt @BridgeAR
doc: add and unify return statements in crypto.md
0613902 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
nodejs@1e07acd

PR-URL: nodejs#19853
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@richardlau richardlau mentioned this pull request Sep 14, 2018
Closed
trivikr pushed a commit to trivikr/node that referenced this pull request Sep 15, 2018
@vsemozhetbyt @trivikr
doc: add and unify return statements in crypto.md
c5a2ef0 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
nodejs@1e07acd

PR-URL: nodejs#19853
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@trivikr trivikr mentioned this pull request Sep 15, 2018
Closed
3 tasks
MylesBorins pushed a commit that referenced this pull request Sep 25, 2018
@vsemozhetbyt @MylesBorins
doc: add and unify return statements in crypto.md
0340dd8 
Conform return statements to the style guide and tool parsers.

Also bring back a description fragment
that seems to be erroneously deleted in
1e07acd

Backport-PR-URL: #22870
PR-URL: #19853
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@BethGriggs BethGriggs mentioned this pull request Oct 30, 2018
Merged
@beevelop beevelop mentioned this pull request Nov 20, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@gibfahn gibfahn gibfahn approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@tniessen tniessen tniessen approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott 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. fast-track PRs that do not need to wait for 48 hours to land. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@vsemozhetbyt @Trott @jasnell @lpinca @tniessen @BridgeAR @gibfahn @trivikr @nodejs-github-bot