summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-04-05 19:29:32 -0700
committerRich Trott <rtrott@gmail.com>2018-04-06 21:09:58 -0700
commit4545cc17b9b95d20d98e7f4fd851d8a987ca9a9c (patch)
treeb90758d68f17849d4a898ed793e933a0c2bd3d55 /doc/api/buffer.md
parenta639ec4ca860c3feb3bdbcf023383840c54c1dda (diff)
downloadandroid-node-v8-4545cc17b9b95d20d98e7f4fd851d8a987ca9a9c.tar.gz
android-node-v8-4545cc17b9b95d20d98e7f4fd851d8a987ca9a9c.tar.bz2
android-node-v8-4545cc17b9b95d20d98e7f4fd851d8a987ca9a9c.zip
doc: improve buf.fill() documentation
* Improve prepositions. * Wrap at 80 characters. * Formalize colloquial text. * Remove unnecessary sentence. * Use colons to introduce example code. PR-URL: https://github.com/nodejs/node/pull/19846 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r--doc/api/buffer.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index c0df6e556b..d3a92f6d35 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -1164,16 +1164,17 @@ changes:
description: The `encoding` parameter is supported now.
-->
-* `value` {string|Buffer|integer} The value to fill `buf` with.
-* `offset` {integer} Number of bytes to skip before starting to fill `buf`. **Default:** `0`.
-* `end` {integer} Where to stop filling `buf` (not inclusive). **Default:** [`buf.length`].
-* `encoding` {string} If `value` is a string, this is its encoding.
+* `value` {string|Buffer|integer} The value with which to fill `buf`.
+* `offset` {integer} Number of bytes to skip before starting to fill `buf`.
+ **Default:** `0`.
+* `end` {integer} Where to stop filling `buf` (not inclusive). **Default:**
+ [`buf.length`].
+* `encoding` {string} The encoding for `value` if `value` is a string.
**Default:** `'utf8'`.
* Returns: {Buffer} A reference to `buf`.
Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
-the entire `buf` will be filled. This is meant to be a small simplification to
-allow the creation and filling of a `Buffer` to be done on a single line.
+the entire `buf` will be filled:
```js
// Fill a `Buffer` with the ASCII character 'h'.
@@ -1184,10 +1185,10 @@ console.log(b.toString());
// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
```
-`value` is coerced to a `uint32` value if it is not a String or Integer.
+`value` is coerced to a `uint32` value if it is not a string or integer.
If the final write of a `fill()` operation falls on a multi-byte character,
-then only the first bytes of that character that fit into `buf` are written.
+then only the bytes of that character that fit into `buf` are written:
```js
// Fill a `Buffer` with a two-byte character.