Skip to content
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.

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

doc: addresses nits in string_decoder, url, util #7026

Merged
merged 1 commit into from
May 31, 2016

Conversation

Fishrock123
Copy link
Contributor

@Fishrock123 Fishrock123 commented May 27, 2016

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

doc

Description of change
  • Only @@toStringTag affects util.isError(), this is the reason why we
    use Object.prototype.toString.call(argument)
  • Shows an actual Euro symbol for reference
  • Uses ascii-line-drawing characters for the URL chart & fixes the
    chart borders

Here's an example of the old and new chart: https://gist.github.com/Fishrock123/72cbf0b687573e1fc1f54622f05f6354

As a note, not all fonts may have proper font widths for all characters, so it is possible it may not show up perfectly in your editor depending on the font used. (I use a customized font in my editor.)

cc @jasnell & @nodejs/documentation

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 27, 2016
@jasnell
Copy link
Member

jasnell commented May 27, 2016

LGTM

@@ -386,8 +386,7 @@ util.isError({ name: 'Error', message: 'an error occurred' })
```

Note that this method relies on `Object.prototype.toString()` behavior. It is
possible to obtain an incorrect result when the `object` argument manipulates
the `@@toStringTag` or overrides the `toString()` method.
possible to obtain an incorrect result when the `object` argument manipulates `@@toStringTag`.
Copy link
Member

Choose a reason for hiding this comment

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

long line

@addaleax
Copy link
Member

LGTM with a nit

@cjihrig
Copy link
Contributor

cjihrig commented May 27, 2016

LGTM

@mscdex mscdex added util Issues and PRs related to the built-in util module. url Issues and PRs related to the legacy built-in url module. string_decoder Issues and PRs related to the string_decoder subsystem. labels May 27, 2016
@benjamingr
Copy link
Member

LGTM

- Only `@@toStringTag` affects `util.isError()`, this is the reason why
it uses `Object.prototype.toString.call(argument)` under the hood.
- Shows an actual Euro symbol for reference.
- Uses line-drawing characters for the URL chart & fixes the chart
borders.

PR-URL: nodejs#7026
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@Fishrock123 Fishrock123 merged commit 0cc9035 into nodejs:master May 31, 2016
@Fishrock123 Fishrock123 deleted the docs-nits branch May 31, 2016 14:30
Fishrock123 added a commit that referenced this pull request Jun 1, 2016
- Only `@@toStringTag` affects `util.isError()`, this is the reason why
it uses `Object.prototype.toString.call(argument)` under the hood.
- Shows an actual Euro symbol for reference.
- Uses line-drawing characters for the URL chart & fixes the chart
borders.

PR-URL: #7026
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
rvagg pushed a commit that referenced this pull request Jun 2, 2016
- Only `@@toStringTag` affects `util.isError()`, this is the reason why
it uses `Object.prototype.toString.call(argument)` under the hood.
- Shows an actual Euro symbol for reference.
- Uses line-drawing characters for the URL chart & fixes the chart
borders.

PR-URL: #7026
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. string_decoder Issues and PRs related to the string_decoder subsystem. url Issues and PRs related to the legacy built-in url module. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants