Skip to content

doc: fix and modernize code examples in crypto.md #10909

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

Closed
vsemozhetbyt wants to merge 8 commits into from
Closed

doc: fix and modernize code examples in crypto.md #10909

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2e27c0d
doc: var -> const / let in crypto.md
vsemozhetbyt Jan 20, 2017
1df278c
doc: fix error in crypto.md code example
vsemozhetbyt Jan 20, 2017
c6e9fdc
doc: equal -> strictEqual, == -> === in crypto.md
vsemozhetbyt Jan 20, 2017
3fd3dd6
doc: update estimated outputs in crypto.md
vsemozhetbyt Jan 20, 2017
a5254fb
doc: snake_case -> camelCase in crypto.md examples
vsemozhetbyt Jan 20, 2017
8501349
doc: concatenation -> multiline template in crypto
vsemozhetbyt Jan 20, 2017
b74e5f9
doc: add missing line break in crypto code example
vsemozhetbyt Jan 20, 2017
9dcca71
doc: add missing link reference in crypto.md
vsemozhetbyt Jan 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ const bob_key = bob.generateKeys();
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

assert(alice_secret, bob_secret);
assert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));
Copy link
Member

@lpinca lpinca Jan 21, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: assert.strictEqual()? Not sure if it is preferred on doc examples.

Edit: nvm fixed in next commit.

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Jan 21, 2017

Choose a reason for hiding this comment

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

Sorry for the confusion, I've tried to do it step by step and to split by topics)

// OK
```

Expand Down