Skip to content

Commit

Permalink
doc: do not identify string as "JavaScript string"
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
Trott authored and targos committed Apr 2, 2018
1 parent d111037 commit 3a3ae01
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down Expand Up @@ -839,8 +839,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');
Expand Down

0 comments on commit 3a3ae01

Please sign in to comment.