Skip to content

doc: improve Sign/Verify examples and docs - #25452

Closed
sam-github wants to merge 1 commit into
nodejs:masterfrom
sam-github:improve-sign-verify-docs
Closed

doc: improve Sign/Verify examples and docs#25452
sam-github wants to merge 1 commit into
nodejs:masterfrom
sam-github:improve-sign-verify-docs

Conversation

@sam-github

@sam-githubsam-github commented Jan 11, 2019

Copy link
Copy Markdown
Contributor
  • Use complete examples that can be pasted and run as-is
  • Move note about algorithm to the functions it applies to
  • Uncapitalize inconsistence use of "Class"
  • Use both EC and RSA keys in the examples
  • Note that hash and digest are two names for the same algorithms
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot

nodejs-github-bot commented Jan 11, 2019

Copy link
Copy Markdown
Collaborator

@sam-github sadly an error occured when I tried to trigger a build :(

@nodejs-github-botnodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Jan 11, 2019
vsemozhetbyt
vsemozhetbyt approved these changes Jan 11, 2019
View reviewed changes

@vsemozhetbytvsemozhetbyt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Doc format LGTM.

Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/crypto.md Outdated
tniessen
tniessen approved these changes Jan 11, 2019
View reviewed changes
Comment threaddoc/api/crypto.md Outdated

@tniessentniessenJan 11, 2019

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.

I would probably express this in an even stronger way, as far as I know, this is specific to OpenSSL.

@sam-githubsam-githubJan 14, 2019

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.

I'm just moving the existing text closer to the API it refers to, I don't want to rework too much unless its got a serious problem. In this case, we never build with anything other than OpenSSL, so doesn't all the docs apply to OpenSSL? I'll add some specific text if you suggest, but I'm not sure what else to say, myself.

Comment threaddoc/api/crypto.md Outdated
@sam-github
sam-githubforce-pushed the improve-sign-verify-docs branch from f5266d7 to 49e4fafCompareJanuary 14, 2019 19:21
@sam-github
doc: improve Sign/Verify examples and docs
97b1132
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms
@sam-github
sam-githubforce-pushed the improve-sign-verify-docs branch from 49e4faf to 97b1132CompareJanuary 14, 2019 19:22
@sam-github

sam-github commented Jan 14, 2019

Copy link
Copy Markdown
ContributorAuthor

ci-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2249/

@sam-github

sam-github commented Jan 14, 2019

Copy link
Copy Markdown
ContributorAuthor

Landed in 273d7dd

@sam-github
sam-github deleted the improve-sign-verify-docs branch January 14, 2019 23:34
sam-github added a commit that referenced this pull request Jan 14, 2019
@sam-github
doc: improve Sign/Verify examples and docs
273d7dd
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms
PR-URL: #25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax pushed a commit that referenced this pull request Jan 15, 2019
@sam-github@addaleax
doc: improve Sign/Verify examples and docs
7123167
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms
PR-URL: #25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
@BridgeARBridgeAR mentioned this pull request Jan 16, 2019
Merged
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
@sam-github@BridgeAR
doc: improve Sign/Verify examples and docs
383b1ac
- Use complete examples that can be pasted and run as-is
- Move note about algorithm to the functions it applies to
- Uncapitalize inconsistence use of "Class"
- Use both EC and RSA keys in the examples
- Note that hash and digest are two names for the same algorithms
PR-URL: nodejs#25452
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Jan 24, 2019
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@tniessentniessentniessen approved these changes
+1 more reviewer
@vsemozhetbytvsemozhetbytvsemozhetbyt approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sam-github@nodejs-github-bot@jasnell@tniessen@vsemozhetbyt