Skip to content

doc: minor improvements to util.md - #6932

Closed
thefourtheye wants to merge 2 commits into
nodejs:masterfrom
thefourtheye:util-doc-update
Closed

doc: minor improvements to util.md#6932
thefourtheye wants to merge 2 commits into
nodejs:masterfrom
thefourtheye:util-doc-update

Conversation

@thefourtheye

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

cc @jasnell @nodejs/documentation

@thefourtheyethefourtheye added util Issues and PRs related to the built-in util module. doc Issues and PRs related to the documentations. labels May 23, 2016
Comment threaddoc/api/util.md
util.isArray([]);
// true
util.isArray(new Array)
util.isArray(new Array);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when were the semicolons removed? the docs wg style guide says we should normally have them.

@jasnell

Copy link
Copy Markdown
Member

LGTM

1 similar comment
@eljefedelrodeodeljefe

Copy link
Copy Markdown
Contributor

LGTM

Comment threaddoc/api/util.md Outdated
If there are more arguments passed to the `util.format()` method than the
number of placeholders, the extra arguments are coerced into strings (for
objects and symbols, `util.inspect()` is used) then concatenated to the
returned string, delimited by a space.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would "each delimited by a space" sound better here?

@thefourtheye

Copy link
Copy Markdown
ContributorAuthor

@mscdex Addressed your comments. PTAL.

@mscdex

Copy link
Copy Markdown
Contributor

LGTM

@thefourtheye

Copy link
Copy Markdown
ContributorAuthor

Landed in 435e673

@thefourtheye
thefourtheye deleted the util-doc-update branch May 29, 2016 06:56
thefourtheye added a commit that referenced this pull request May 29, 2016
PR-URL: #6932
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request May 30, 2016
PR-URL: nodejs#6932
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
rvagg pushed a commit that referenced this pull request Jun 2, 2016
PR-URL: #6932
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.utilIssues and PRs related to the built-in util module.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@thefourtheye@jasnell@eljefedelrodeodeljefe@mscdex@Fishrock123@MylesBorins