Update for crypto.md #21500

ghost · 2018-06-24T07:37:20Z

Description:

crypto.randomFillSync - update for JS example
crypto.scrypt, crypto.scryptSync - update for options description

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

crypto.randomFillSync - update for JS example crypto.scrypt, crypto.scryptSync - update for options description

vsemozhetbyt

Thank you! Just some tiny nits.

vsemozhetbyt · 2018-06-24T08:07:30Z

doc/api/crypto.md

@@ -2149,12 +2149,10 @@ added: v10.5.0
 - `salt` {string|Buffer|TypedArray}
 - `keylen` {number}
 - `options` {Object}
-  - `N` {number} CPU/memory cost parameter. Must be a power of two greater
-                 than one. **Default:** `16384`.
+  - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`.


Please, wrap long lines at 80 characters or less. Just align with the first list item character, like this:

- `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`.

vsemozhetbyt · 2018-06-24T08:07:45Z

doc/api/crypto.md

  - `r` {number} Block size parameter. **Default:** `8`.
  - `p` {number} Parallelization parameter. **Default:** `1`.
-  - `maxmem` {number} Memory upper bound. It is an error when (approximately)
-                      `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.
+  - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.


Maybe `128*N*r -> `128 * N * r for better readability?

vsemozhetbyt · 2018-06-24T08:09:07Z

doc/api/crypto.md

@@ -2195,12 +2193,10 @@ added: v10.5.0
 - `salt` {string|Buffer|TypedArray}
 - `keylen` {number}
 - `options` {Object}
-  - `N` {number} CPU/memory cost parameter. Must be a power of two greater
-                 than one. **Default:** `16384`.
+  - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`.


The same re wrapping.

vsemozhetbyt · 2018-06-24T08:09:38Z

doc/api/crypto.md

  - `r` {number} Block size parameter. **Default:** `8`.
  - `p` {number} Parallelization parameter. **Default:** `1`.
-  - `maxmem` {number} Memory upper bound. It is an error when (approximately)
-                      `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.
+  - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.


The same re wrapping and spaces.

crypto.scrypt, crypto.scryptSync - update for formatting

ghost · 2018-06-26T14:23:49Z

Done. Please check it.

tniessen · 2018-06-26T14:27:05Z

doc/api/crypto.md

@@ -2150,11 +2150,11 @@ added: v10.5.0
 - `keylen` {number}
 - `options` {Object}
  - `N` {number} CPU/memory cost parameter. Must be a power of two greater
-                 than one. **Default:** `16384`.
+    than one. **Default:** `16384`.


Do we prefer this style @vsemozhetbyt? Seems like the current style causes issues when converted to HTML?

Yeah, the extra indentation produces false code blocks in HTML (not sure if this is per Markdown spec or just a quirk of marked we use in md-2-HTML conversion). See in the last nightly docs:

https://nodejs.org/download/nightly/v11.0.0-nightly201806268836a0d780/docs/api/crypto.html#crypto_crypto_scrypt_password_salt_keylen_options_callback

vsemozhetbyt

Just two nits that can be addressed on landing if it is not convenient to fix them now)

vsemozhetbyt · 2018-06-26T15:32:41Z

doc/api/crypto.md

  - `r` {number} Block size parameter. **Default:** `8`.
  - `p` {number} Parallelization parameter. **Default:** `1`.
  - `maxmem` {number} Memory upper bound. It is an error when (approximately)
-                      `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.
+    `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`.


Sorry for not spotting this first time: it seems we lack the period between maxmem` and **Default:**. Can you add it since we are already here?)

@vsemozhetbyt "it seems we lack the period between maxmem and **Default:**" What do you mean on "period" word? Could you please write an example?

Sorry for the ambiguity) I mean we need this fix:

maxmem`. **Default:**

I see. Sure.

vsemozhetbyt · 2018-06-26T15:32:57Z

doc/api/crypto.md

  - `r` {number} Block size parameter. **Default:** `8`.
  - `p` {number} Parallelization parameter. **Default:** `1`.
  - `maxmem` {number} Memory upper bound. It is an error when (approximately)
-                      `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`.
+    `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`.


crypto.scrypt, crypto.scryptSync - added dot symbol

ghost · 2018-06-26T17:50:19Z

Please re-check it.

vsemozhetbyt · 2018-06-26T18:55:24Z

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

PR-URL: #21500 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>

vsemozhetbyt · 2018-06-27T17:36:23Z

Landed in 02fd93d
Thank you!

PR-URL: #21500 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>

Update for crypto.md

2c00b9a

crypto.randomFillSync - update for JS example crypto.scrypt, crypto.scryptSync - update for options description

nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Jun 24, 2018

vsemozhetbyt reviewed Jun 24, 2018

View reviewed changes

vsemozhetbyt mentioned this pull request Jun 25, 2018

crypto: add better scrypt option aliases #21525

Closed

4 tasks

Update crypto.md

8c0c102

crypto.scrypt, crypto.scryptSync - update for formatting

tniessen reviewed Jun 26, 2018

View reviewed changes

vsemozhetbyt approved these changes Jun 26, 2018

View reviewed changes

Update crypto.md

ad420c8

crypto.scrypt, crypto.scryptSync - added dot symbol

vsemozhetbyt approved these changes Jun 26, 2018

View reviewed changes

vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 26, 2018

trivikr approved these changes Jun 27, 2018

View reviewed changes

tniessen approved these changes Jun 27, 2018

View reviewed changes

vsemozhetbyt pushed a commit that referenced this pull request Jun 27, 2018

doc: fix code example and formatting in crypto.md

02fd93d

PR-URL: #21500 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>

vsemozhetbyt closed this Jun 27, 2018

ghost deleted the patch-1 branch June 28, 2018 12:43

targos pushed a commit that referenced this pull request Jun 28, 2018

doc: fix code example and formatting in crypto.md

504c0cd

PR-URL: #21500 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>

targos mentioned this pull request Jul 3, 2018

v10.6.0 proposal #21629

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update for crypto.md #21500

Update for crypto.md #21500

ghost commented Jun 24, 2018 •

edited by ghost

Loading

vsemozhetbyt left a comment

vsemozhetbyt Jun 24, 2018

vsemozhetbyt Jun 24, 2018

vsemozhetbyt Jun 24, 2018 •

edited

Loading

vsemozhetbyt Jun 24, 2018

vsemozhetbyt Jun 24, 2018

ghost commented Jun 26, 2018

tniessen Jun 26, 2018 •

edited

Loading

vsemozhetbyt Jun 26, 2018

vsemozhetbyt left a comment

vsemozhetbyt Jun 26, 2018

ghost Jun 26, 2018 •

edited by ghost

Loading

vsemozhetbyt Jun 26, 2018

ghost Jun 26, 2018

vsemozhetbyt Jun 26, 2018

ghost commented Jun 26, 2018

vsemozhetbyt commented Jun 26, 2018

vsemozhetbyt commented Jun 27, 2018

Update for crypto.md #21500

Update for crypto.md #21500

Conversation

ghost commented Jun 24, 2018 • edited by ghost Loading

Checklist

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt Jun 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jun 26, 2018

tniessen Jun 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Jun 26, 2018 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jun 26, 2018

vsemozhetbyt commented Jun 26, 2018

vsemozhetbyt commented Jun 27, 2018

ghost commented Jun 24, 2018 •

edited by ghost

Loading

vsemozhetbyt Jun 24, 2018 •

edited

Loading

tniessen Jun 26, 2018 •

edited

Loading

ghost Jun 26, 2018 •

edited by ghost

Loading