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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions doc/api/string_decoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ internal buffer is used to ensure that the decoded string does not contain
any incomplete multibyte characters. These are held in the buffer until the
next call to `stringDecoder.write()` or until `stringDecoder.end()` is called.

In the following example, the three UTF-8 encoded bytes of the European euro
symbol are written over three separate operations:
In the following example, the three UTF-8 encoded bytes of the European Euro
symbol (`€`) are written over three separate operations:

```js
const StringDecoder = require('string_decoder').StringDecoder;
Expand Down
22 changes: 11 additions & 11 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ The following details each of the components of a parsed URL. The example
illustrate each.

```
+---------------------------------------------------------------------------+
| href |
+----------++-----------+-----------------+-------------------------+-------+
| protocol || auth | host | path | hash |
| || +----------+------+----------+--------------+ |
| || | hostname | port | pathname | search | |
| || | | | +-+------------+ |
| || | | | | | query | |
" http: // user:pass @ host.com : 8080 /p/a/t/h ? query=string #hash "
| || | | | | | | |
+----------++-----------+-----------+------+----------+-+-----------+-------+
┌─────────────────────────────────────────────────────────────────────────────┐
href
├──────────┬┬───────────┬─────────────────┬───────────────────────────┬───────┤
protocol ││ auth host path hash
││ ├──────────┬──────┼──────────┬────────────────┤
││ hostname port pathname search
││ ├─┬──────────────┤
││ │ │ query
" http: // user:pass @ host.com : 8080 /p/a/t/h ? query=string #hash "
││ │ │
└──────────┴┴───────────┴──────────┴──────┴──────────┴─┴──────────────┴───────┘
(all spaces in the "" line should be ignored -- they're purely for formatting)
```

Expand Down
2 changes: 1 addition & 1 deletion doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,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.
`@@toStringTag`.

```js
const util = require('util');
Expand Down