summaryrefslogtreecommitdiff
path: root/doc/api/buffer.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-03-29 22:54:37 -0700
committerRich Trott <rtrott@gmail.com>2018-04-01 23:08:14 -0700
commit6de1a12e496b58b1ab1c150b3cee8a8d45040edb (patch)
treeb9a21b9aab3d4bfac954cad4f642a001c50ec451 /doc/api/buffer.md
parenta3160b7a294fa12a987b562c01a3f78a79e21ed6 (diff)
downloadandroid-node-v8-6de1a12e496b58b1ab1c150b3cee8a8d45040edb.tar.gz
android-node-v8-6de1a12e496b58b1ab1c150b3cee8a8d45040edb.tar.bz2
android-node-v8-6de1a12e496b58b1ab1c150b3cee8a8d45040edb.zip
doc: remove "if provided" for optional arguments
Remove "if provided" when discussing arguments that are explicitly indicated to be optional and have default values. PR-URL: https://github.com/nodejs/node/pull/19690 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@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 ec500ceb96..42641f4b7e 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 `string`. If provided, the `encoding`
-parameter identifies the character encoding of `string`.
+Creates a new `Buffer` containing `string`. 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 `string`. If provided, the `encoding`
-parameter identifies the character encoding of `string`.
+Creates a new `Buffer` containing `string`. The `encoding` parameter identifies
+the character encoding of `string`.
```js
const buf1 = Buffer.from('this is a tést');