Skip to content

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

Closed
vsemozhetbyt wants to merge 3 commits into
nodejs:masterfrom
vsemozhetbyt:doc-crypto-nits
Closed

doc: add and unify return statements in crypto.md#19853
vsemozhetbyt wants to merge 3 commits into
nodejs:masterfrom
vsemozhetbyt:doc-crypto-nits

Conversation

@vsemozhetbyt

@vsemozhetbytvsemozhetbyt commented Apr 6, 2018

Copy link
Copy Markdown
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-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Apr 6, 2018
@vsemozhetbytvsemozhetbyt added the crypto Issues and PRs related to the crypto subsystem. label Apr 6, 2018
@vsemozhetbyt

vsemozhetbyt commented Apr 6, 2018

Copy link
Copy Markdown
ContributorAuthor

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

@vsemozhetbytvsemozhetbyt 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

@TrottTrott left a comment

Copy link
Copy Markdown
Member

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

Trott commented Apr 6, 2018

Copy link
Copy Markdown
Member

@nodejs/documentation

@Trott

Trott commented Apr 6, 2018

Copy link
Copy Markdown
Member

@nodejs/crypto

lpinca
lpinca approved these changes Apr 7, 2018
View reviewed changes
Comment threaddoc/api/crypto.md
- `signatureFormat` {string}
- Returns: {boolean} `true` or `false` depending on the validity of the
signature for the data and public key.

@lpincalpincaApr 7, 2018

Copy link
Copy Markdown
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?

@vsemozhetbytvsemozhetbytApr 7, 2018

Copy link
Copy Markdown
ContributorAuthor

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

@BridgeARBridgeAR left a comment

Copy link
Copy Markdown
Member

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.

Comment threaddoc/api/crypto.md
@BridgeARBridgeAR added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 8, 2018
@vsemozhetbyt

vsemozhetbyt commented Apr 8, 2018

Copy link
Copy Markdown
ContributorAuthor

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

tniessen
tniessen approved these changes Apr 8, 2018
View reviewed changes

@tniessentniessen left a comment

Copy link
Copy Markdown
Member

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.

Comment threaddoc/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

@tniessentniessenApr 8, 2018

Copy link
Copy Markdown
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

@vsemozhetbytvsemozhetbytApr 8, 2018

Copy link
Copy Markdown
ContributorAuthor

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

vsemozhetbyt commented Apr 8, 2018

Copy link
Copy Markdown
ContributorAuthor

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 <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>
@vsemozhetbyt

vsemozhetbyt commented Apr 8, 2018

Copy link
Copy Markdown
ContributorAuthor

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 <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
@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 <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>
@richardlaurichardlau 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 <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>
@trivikrtrivikr 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 <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>
@BethGriggsBethGriggs mentioned this pull request Oct 30, 2018
Merged
@beevelopbeevelop mentioned this pull request Nov 20, 2018
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@TrottTrottTrott approved these changes
@lpincalpincalpinca approved these changes
@tniessentniessentniessen approved these changes
@BridgeARBridgeARBridgeAR approved these changes
@trivikrtrivikrtrivikr approved these changes
+1 more reviewer
@gibfahngibfahngibfahn approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to the documentations.fast-trackPRs that do not need to wait for 48 hours to land.toolsIssues 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