summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-03-29 22:50:52 -0700
committerRich Trott <rtrott@gmail.com>2018-04-01 22:54:29 -0700
commita3160b7a294fa12a987b562c01a3f78a79e21ed6 (patch)
tree6a734b6d3ad3fe95711e57d51c611f964e8bfd2c /doc/api/buffer.md
parent52a9f42d97d98604b2781a90fd3674db054ea2cc (diff)
downloadandroid-node-v8-a3160b7a294fa12a987b562c01a3f78a79e21ed6.tar.gz
android-node-v8-a3160b7a294fa12a987b562c01a3f78a79e21ed6.tar.bz2
android-node-v8-a3160b7a294fa12a987b562c01a3f78a79e21ed6.zip
doc: do not identify string as "JavaScript string"
A parameter that is explicitly identified as a string does not need to be further specified in the text as a "JavaScript string". Remove the type altogether as it is indicated in the argument description. PR-URL: https://github.com/nodejs/node/pull/19689 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/buffer.md')
-rw-r--r--doc/api/buffer.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 1e81762e98..ec500ceb96 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -461,8 +461,8 @@ changes:
* `string` {string} String to encode.
* `encoding` {string} The encoding of `string`. **Default:** `'utf8'`
-Creates a new `Buffer` containing the given JavaScript string `string`. If
-provided, the `encoding` parameter identifies the character encoding of `string`.
+Creates a new `Buffer` containing `string`. If provided, the `encoding`
+parameter identifies the character encoding of `string`.
```js
const buf1 = new Buffer('this is a tést');
@@ -847,8 +847,8 @@ added: v5.10.0
* `string` {string} A string to encode.
* `encoding` {string} The encoding of `string`. **Default:** `'utf8'`
-Creates a new `Buffer` containing the given JavaScript string `string`. If
-provided, the `encoding` parameter identifies the character encoding of `string`.
+Creates a new `Buffer` containing `string`. If provided, the `encoding`
+parameter identifies the character encoding of `string`.
```js
const buf1 = Buffer.from('this is a tést');