Skip to content

doc: do not identify string as "JavaScript string" #19689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: do not identify string as "JavaScript string" #19689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
  • Loading branch information
@Trott
Trott committed Mar 30, 2018
commit 642f6831df1017d8e3de1061a449f02602c235e5
8 changes: 4 additions & 4 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,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 @@ -850,8 +850,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