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.

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

Jump to bottom

doc: Change straight quotes to curly quotes #808

Closed
wants to merge 1 commit into from
Closed

doc: Change straight quotes to curly quotes #808

Show file tree
Hide file tree
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
16 changes: 8 additions & 8 deletions doc/api/addons.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ knowledge of several libraries:
- Others. Look in `deps/` for what else is available.

Node statically compiles all its dependencies into the executable.
When compiling your module, you don't need to worry about linking to
When compiling your module, you don’t need to worry about linking to
any of these libraries.

All of the following examples are available for
Expand All @@ -31,7 +31,7 @@ used as a starting-point for your own Addon.

## Hello world

To get started let's make a small Addon which is the C++ equivalent of
To get started let’s make a small Addon which is the C++ equivalent of
the following JavaScript code:

module.exports.hello = function() { return 'world'; };
Expand Down Expand Up @@ -60,7 +60,7 @@ Note that all Node addons must export an initialization function:
void Initialize (Handle<Object> exports);
NODE_MODULE(module_name, Initialize)

There is no semi-colon after `NODE_MODULE` as it's not a function (see
There is no semi-colon after `NODE_MODULE` as it’s not a function (see
`node.h`).

The `module_name` needs to match the filename of the final binary (minus the
Expand Down Expand Up @@ -106,7 +106,7 @@ Please see patterns below for further information or

Below are some addon patterns to help you get started. Consult the online
[v8 reference](http://izs.me/v8-docs/main.html) for help with the various v8
calls, and v8's [Embedder's Guide](http://code.google.com/apis/v8/embed.html)
calls, and v8’s [Embedder’s Guide](http://code.google.com/apis/v8/embed.html)
for an explanation of several concepts used such as handles, scopes,
function templates, etc.

Expand Down Expand Up @@ -183,7 +183,7 @@ You can test it with the following JavaScript snippet:
### Callbacks

You can pass JavaScript functions to a C++ function and execute them from
there. Here's `addon.cc`:
there. Here’s `addon.cc`:

// addon.cc
#include <node.h>
Expand Down Expand Up @@ -346,7 +346,7 @@ Then in `myobject.h` make your wrapper inherit from `node::ObjectWrap`:
#endif

And in `myobject.cc` implement the various methods that you want to expose.
Here we expose the method `plusOne` by adding it to the constructor's
Here we expose the method `plusOne` by adding it to the constructor’s
prototype:

// myobject.cc
Expand Down Expand Up @@ -426,7 +426,7 @@ explicitly instantiating them with the `new` operator in JavaScript, e.g.
// instead of:
// var obj = new addon.Object();

Let's register our `createObject` method in `addon.cc`:
Let’s register our `createObject` method in `addon.cc`:

// addon.cc
#include <node.h>
Expand Down Expand Up @@ -564,7 +564,7 @@ Test it with:
### Passing wrapped objects around

In addition to wrapping and returning C++ objects, you can pass them around
by unwrapping them with Node's `node::ObjectWrap::Unwrap` helper function.
by unwrapping them with Node’s `node::ObjectWrap::Unwrap` helper function.
In the following `addon.cc` we introduce a function `add()` that can take on two
`MyObject` objects:

Expand Down
18 changes: 9 additions & 9 deletions doc/api/buffer.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Stability: 3 - Stable

Pure JavaScript is Unicode friendly but not nice to binary data. When
dealing with TCP streams or the file system, it's necessary to handle octet
dealing with TCP streams or the file system, it’s necessary to handle octet
streams. Node has several strategies for manipulating, creating, and
consuming octet streams.

Expand Down Expand Up @@ -39,9 +39,9 @@ encoding method. Here are the different string encodings.

Creating a typed array from a `Buffer` works with the following caveats:

1. The buffer's memory is copied, not shared.
1. The buffer’s memory is copied, not shared.

2. The buffer's memory is interpreted as an array, not a byte array. That is,
2. The buffer’s memory is interpreted as an array, not a byte array. That is,
`new Uint32Array(new Buffer([1,2,3,4]))` creates a 4-element `Uint32Array`
with elements `[1,2,3,4]`, not an `Uint32Array` with a single element
`[0x1020304]` or `[0x4030201]`.
Expand Down Expand Up @@ -463,7 +463,7 @@ Reads a signed 8 bit integer from the buffer at the specified offset.
Set `noAssert` to true to skip validation of `offset`. This means that `offset`
may be beyond the end of the buffer. Defaults to `false`.

Works as `buffer.readUInt8`, except buffer contents are treated as two's
Works as `buffer.readUInt8`, except buffer contents are treated as two’s
complement signed values.

### buf.readInt16LE(offset[, noAssert])
Expand All @@ -479,7 +479,7 @@ specified endian format.
Set `noAssert` to true to skip validation of `offset`. This means that `offset`
may be beyond the end of the buffer. Defaults to `false`.

Works as `buffer.readUInt16*`, except buffer contents are treated as two's
Works as `buffer.readUInt16*`, except buffer contents are treated as two’s
complement signed values.

### buf.readInt32LE(offset[, noAssert])
Expand All @@ -495,7 +495,7 @@ specified endian format.
Set `noAssert` to true to skip validation of `offset`. This means that `offset`
may be beyond the end of the buffer. Defaults to `false`.

Works as `buffer.readUInt32*`, except buffer contents are treated as two's
Works as `buffer.readUInt32*`, except buffer contents are treated as two’s
complement signed values.

### buf.readFloatLE(offset[, noAssert])
Expand Down Expand Up @@ -654,7 +654,7 @@ that `value` may be too large for the specific function and `offset` may be
beyond the end of the buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness. Defaults to `false`.

Works as `buffer.writeUInt8`, except value is written out as a two's complement
Works as `buffer.writeUInt8`, except value is written out as a two’s complement
signed integer into `buffer`.

### buf.writeInt16LE(value, offset[, noAssert])
Expand All @@ -672,7 +672,7 @@ that `value` may be too large for the specific function and `offset` may be
beyond the end of the buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness. Defaults to `false`.

Works as `buffer.writeUInt16*`, except value is written out as a two's
Works as `buffer.writeUInt16*`, except value is written out as a two’s
complement signed integer into `buffer`.

### buf.writeInt32LE(value, offset[, noAssert])
Expand All @@ -690,7 +690,7 @@ that `value` may be too large for the specific function and `offset` may be
beyond the end of the buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness. Defaults to `false`.

Works as `buffer.writeUInt32*`, except value is written out as a two's
Works as `buffer.writeUInt32*`, except value is written out as a two’s
complement signed integer into `buffer`.

### buf.writeFloatLE(value, offset[, noAssert])
Expand Down
54 changes: 27 additions & 27 deletions doc/api/child_process.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Node provides a tri-directional `popen(3)` facility through the
`child_process` module.

It is possible to stream data through a child's `stdin`, `stdout`, and
It is possible to stream data through a child’s `stdin`, `stdout`, and
`stderr` in a fully non-blocking way. (Note that some programs use
line-buffered I/O internally. That doesn't affect node.js but it means
line-buffered I/O internally. That doesn’t affect node.js but it means
data you send to the child process may not be immediately consumed.)

To create a child process use `require('child_process').spawn()` or
Expand Down Expand Up @@ -94,7 +94,7 @@ Messages send by `.send(message, [sendHandle])` are obtained using the

* {Stream object}

A `Writable Stream` that represents the child process's `stdin`.
A `Writable Stream` that represents the child process’s `stdin`.
Closing this stream via `end()` often causes the child process to terminate.

If the child stdio streams are shared with the parent, then this will
Expand All @@ -104,7 +104,7 @@ not be set.

* {Stream object}

A `Readable Stream` that represents the child process's `stdout`.
A `Readable Stream` that represents the child process’s `stdout`.

If the child stdio streams are shared with the parent, then this will
not be set.
Expand All @@ -113,7 +113,7 @@ not be set.

* {Stream object}

A `Readable Stream` that represents the child process's `stderr`.
A `Readable Stream` that represents the child process’s `stderr`.

If the child stdio streams are shared with the parent, then this will
not be set.
Expand All @@ -134,7 +134,7 @@ Example:

### child.connected

* {Boolean} Set to false after `.disconnect' is called
* {Boolean} Set to false after `.disconnect` is called

If `.connected` is false, it is no longer possible to send messages.

Expand All @@ -159,7 +159,7 @@ May emit an `'error'` event when the signal cannot be delivered. Sending a
signal to a child process that has already exited is not an error but may
have unforeseen consequences: if the PID (the process ID) has been reassigned
to another process, the signal will be delivered to that process instead.
What happens next is anyone's guess.
What happens next is anyone’s guess.

Note that while the function is called `kill`, the signal delivered to the
child process may not actually kill it. `kill` really just sends a signal
Expand Down Expand Up @@ -292,7 +292,7 @@ gracefully once there are no other connections keeping it alive. After calling
this method the `.connected` flag will be set to `false` in both the parent and
child, and it is no longer possible to send messages.

The 'disconnect' event will be emitted when there are no messages in the process
The `disconnect` event will be emitted when there are no messages in the process
of being received, most likely immediately.

Note that you can also call `process.disconnect()` in the child process when the
Expand All @@ -309,7 +309,7 @@ callback or returning an EventEmitter).
* `args` {Array} List of string arguments
* `options` {Object}
* `cwd` {String} Current working directory of the child process
* `stdio` {Array|String} Child's stdio configuration. (See below)
* `stdio` {Array|String} Child’s stdio configuration. (See below)
* `env` {Object} Environment key-value pairs
* `detached` {Boolean} The child will be a process group leader. (See below)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
Expand Down Expand Up @@ -391,7 +391,7 @@ Example of checking for failed exec:
console.log('Failed to start child process.');
});

The 'stdio' option to `child_process.spawn()` is an array where each
The `stdio` option to `child_process.spawn()` is an array where each
index corresponds to a fd in the child. The value is one of the following:

1. `'pipe'` - Create a pipe between the child process and the parent process.
Expand All @@ -408,9 +408,9 @@ index corresponds to a fd in the child. The value is one of the following:
process.on('message').
3. `'ignore'` - Do not set this file descriptor in the child. Note that Node
will always open fd 0 - 2 for the processes it spawns. When any of these is
ignored node will open `/dev/null` and attach it to the child's fd.
ignored node will open `/dev/null` and attach it to the child’s fd.
4. `Stream` object - Share a readable or writable stream that refers to a tty,
file, socket, or a pipe with the child process. The stream's underlying
file, socket, or a pipe with the child process. The stream’s underlying
file descriptor is duplicated in the child process to the fd that
corresponds to the index in the `stdio` array. Note that the stream must
have an underlying descriptor (file streams do not until the `'open'`
Expand All @@ -433,7 +433,7 @@ Example:

var spawn = require('child_process').spawn;

// Child will use parent's stdios
// Child will use parent’s stdios
spawn('prg', [], { stdio: 'inherit' });

// Spawn child sharing only stderr
Expand All @@ -449,7 +449,7 @@ after the parent exits.

By default, the parent will wait for the detached child to exit. To prevent
the parent from waiting for a given `child`, use the `child.unref()` method,
and the parent's event loop will not include the child in its reference count.
and the parent’s event loop will not include the child in its reference count.

Example of detaching a long-running process and redirecting its output to a
file:
Expand All @@ -468,7 +468,7 @@ file:

When using the `detached` option to start a long-running process, the process
will not stay running in the background unless it is provided with a `stdio`
configuration that is not connected to the parent. If the parent's `stdio` is
configuration that is not connected to the parent. If the parent’s `stdio` is
inherited, the child will remain attached to the controlling terminal.

See also: `child_process.exec()` and `child_process.fork()`
Expand Down Expand Up @@ -568,7 +568,7 @@ leaner than `child_process.exec`. It has the same options.
(Default: `process.execArgv`)
* `silent` {Boolean} If true, stdin, stdout, and stderr of the child will be
piped to the parent, otherwise they will be inherited from the parent, see
the "pipe" and "inherit" options for `spawn()`'s `stdio` for more details
the "pipe" and "inherit" options for `spawn()`’s `stdio` for more details
(default is false)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
Expand Down Expand Up @@ -606,7 +606,7 @@ configuration at startup.
* `cwd` {String} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the spawned process
- supplying this value will override `stdio[0]`
* `stdio` {Array} Child's stdio configuration.
* `stdio` {Array} Child’s stdio configuration.
* `env` {Object} Environment key-value pairs
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
Expand All @@ -624,9 +624,9 @@ configuration at startup.
* `error` {Error} The error object if the child process failed or timed out

`spawnSync` will not return until the child process has fully closed. When a
timeout has been encountered and `killSignal` is sent, the method won't return
timeout has been encountered and `killSignal` is sent, the method won’t return
until the process has completely exited. That is to say, if the process handles
the `SIGTERM` signal and doesn't exit, your process will wait until the child
the `SIGTERM` signal and doesn’t exit, your process will wait until the child
process has exited.

### child_process.execFileSync(command[, args][, options])
Expand All @@ -637,8 +637,8 @@ process has exited.
* `cwd` {String} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the spawned process
- supplying this value will override `stdio[0]`
* `stdio` {Array} Child's stdio configuration. (Default: 'pipe')
- `stderr` by default will be output to the parent process' stderr unless
* `stdio` {Array} Child’s stdio configuration. (Default: 'pipe')
- `stderr` by default will be output to the parent’s process stderr unless
`stdio` is specified
* `env` {Object} Environment key-value pairs
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
Expand All @@ -650,9 +650,9 @@ process has exited.
* return: {Buffer|String} The stdout from the command

`execFileSync` will not return until the child process has fully closed. When a
timeout has been encountered and `killSignal` is sent, the method won't return
timeout has been encountered and `killSignal` is sent, the method won’t return
until the process has completely exited. That is to say, if the process handles
the `SIGTERM` signal and doesn't exit, your process will wait until the child
the `SIGTERM` signal and doesn’t exit, your process will wait until the child
process has exited.

If the process times out, or has a non-zero exit code, this method ***will***
Expand All @@ -667,8 +667,8 @@ throw. The `Error` object will contain the entire result from
* `cwd` {String} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the spawned process
- supplying this value will override `stdio[0]`
* `stdio` {Array} Child's stdio configuration. (Default: 'pipe')
- `stderr` by default will be output to the parent process' stderr unless
* `stdio` {Array} Child’s stdio configuration. (Default: 'pipe')
- `stderr` by default will be output to the parent’s process stderr unless
`stdio` is specified
* `env` {Object} Environment key-value pairs
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
Expand All @@ -680,9 +680,9 @@ throw. The `Error` object will contain the entire result from
* return: {Buffer|String} The stdout from the command

`execSync` will not return until the child process has fully closed. When a
timeout has been encountered and `killSignal` is sent, the method won't return
timeout has been encountered and `killSignal` is sent, the method won’t return
until the process has completely exited. That is to say, if the process handles
the `SIGTERM` signal and doesn't exit, your process will wait until the child
the `SIGTERM` signal and doesn’t exit, your process will wait until the child
process has exited.

If the process times out, or has a non-zero exit code, this method ***will***
Expand Down
Loading