doc: add and unify return statements in crypto.md #19853
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
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
added
doc
jasnell
approved these changes
Apr 6, 2018
vsemozhetbyt
added
the
author ready
Trott
approved these changes
Apr 6, 2018
|
@nodejs/documentation |
|
@nodejs/crypto |
lpinca
approved these changes
Apr 7, 2018
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. | |||
|
|
|||
gibfahn
approved these changes
Apr 7, 2018
trivikr
approved these changes
Apr 7, 2018
BridgeAR
approved these changes
Apr 8, 2018
|
@nodejs/crypto can somebody confirm that added return types are correct? |
tniessen
approved these changes
Apr 8, 2018
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 |
There was a problem hiding this comment.
Uppercase for consistency? {Buffer | string} The
There was a problem hiding this comment.
Done in the fixup commit.
|
CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/453/ |
vsemozhetbyt
added a commit
that referenced
this pull request
Apr 8, 2018
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
|
Landed in 0bd3da1 |
targos
pushed a commit
that referenced
this pull request
Apr 12, 2018
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
May 1, 2018
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
trivikr
pushed a commit
to trivikr/node
that referenced
this pull request
Sep 15, 2018
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
3 tasks
MylesBorins
pushed a commit
that referenced
this pull request
Sep 25, 2018
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 <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Merged
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.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesConform 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)