summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-10-23 15:35:13 -0700
committerRich Trott <rtrott@gmail.com>2019-10-26 11:25:43 -0700
commit0ed22668bb2605a0f1515aec3944e51f8d90129e (patch)
tree97767df7331ae97eac76d83c561e71816346a561 /doc/api
parent10040500da6af33b602e35c3f3bbe28cf76c4c4a (diff)
downloadandroid-node-v8-0ed22668bb2605a0f1515aec3944e51f8d90129e.tar.gz
android-node-v8-0ed22668bb2605a0f1515aec3944e51f8d90129e.tar.bz2
android-node-v8-0ed22668bb2605a0f1515aec3944e51f8d90129e.zip
doc: delete "a number of" things in the docs
Delete "a number of" phrases in the docs. See what I did there? Ha ha. Ha ha. Ha. ...heh.. <clears throat/> PR-URL: https://github.com/nodejs/node/pull/30103 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/addons.md28
-rw-r--r--doc/api/dgram.md7
-rw-r--r--doc/api/globals.md6
-rw-r--r--doc/api/modules.md6
-rw-r--r--doc/api/os.md4
-rw-r--r--doc/api/util.md9
6 files changed, 28 insertions, 32 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md
index 6b440bf674..774be1a7aa 100644
--- a/doc/api/addons.md
+++ b/doc/api/addons.md
@@ -34,16 +34,14 @@ involving knowledge of several components and APIs:
off-loading work via libuv to non-blocking system operations, worker threads
or a custom use of libuv's threads.
-* Internal Node.js libraries. Node.js itself exports a number of C++ APIs
- that Addons can use &mdash; the most important of which is the
- `node::ObjectWrap` class.
+* Internal Node.js libraries. Node.js itself exports C++ APIs that Addons can
+ use, the most important of which is the `node::ObjectWrap` class.
-* Node.js includes a number of other statically linked libraries including
- OpenSSL. These other libraries are located in the `deps/` directory in the
- Node.js source tree. Only the libuv, OpenSSL, V8 and zlib symbols are
- purposefully re-exported by Node.js and may be used to various extents by
- Addons.
- See [Linking to Node.js' own dependencies][] for additional information.
+* Node.js includes other statically linked libraries including OpenSSL. These
+ other libraries are located in the `deps/` directory in the Node.js source
+ tree. Only the libuv, OpenSSL, V8 and zlib symbols are purposefully
+ re-exported by Node.js and may be used to various extents by Addons. See
+ [Linking to Node.js' own dependencies][] for additional information.
All of the following examples are available for [download][] and may
be used as the starting-point for an Addon.
@@ -331,12 +329,12 @@ try {
### Linking to Node.js' own dependencies
-Node.js uses a number of statically linked libraries such as V8, libuv and
-OpenSSL. All Addons are required to link to V8 and may link to any of the
-other dependencies as well. Typically, this is as simple as including
-the appropriate `#include <...>` statements (e.g. `#include <v8.h>`) and
-`node-gyp` will locate the appropriate headers automatically. However, there
-are a few caveats to be aware of:
+Node.js uses statically linked libraries such as V8, libuv and OpenSSL. All
+Addons are required to link to V8 and may link to any of the other dependencies
+as well. Typically, this is as simple as including the appropriate
+`#include <...>` statements (e.g. `#include <v8.h>`) and `node-gyp` will locate
+the appropriate headers automatically. However, there are a few caveats to be
+aware of:
* When `node-gyp` runs, it will detect the specific release version of Node.js
and download either the full source tarball or just the headers. If the full
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index aea51ad711..f24bd5225b 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -622,8 +622,7 @@ packet is allowed to travel through, specifically for multicast traffic. Each
router or gateway that forwards a packet decrements the TTL. If the TTL is
decremented to 0 by a router, it will not be forwarded.
-The argument passed to `socket.setMulticastTTL()` is a number of hops
-between 0 and 255. The default on most systems is `1` but can vary.
+The `ttl` argument may be between 0 and 255. The default on most systems is `1`.
### socket.setRecvBufferSize(size)
<!-- YAML
@@ -658,8 +657,8 @@ travel through. Each router or gateway that forwards a packet decrements the
TTL. If the TTL is decremented to 0 by a router, it will not be forwarded.
Changing TTL values is typically done for network probes or when multicasting.
-The argument to `socket.setTTL()` is a number of hops between 1 and 255.
-The default on most systems is 64 but can vary.
+The `ttl` argument may be between between 1 and 255. The default on most systems
+is 64.
### socket.unref()
<!-- YAML
diff --git a/doc/api/globals.md b/doc/api/globals.md
index a794cfb196..8b112c467d 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -13,9 +13,9 @@ to be global but are not. They exist only in the scope of modules, see the
* [`module`][]
* [`require()`][]
-The objects listed here are specific to Node.js. There are a number of
-[built-in objects][] that are part of the JavaScript language itself, which are
-also globally accessible.
+The objects listed here are specific to Node.js. There are [built-in objects][]
+that are part of the JavaScript language itself, which are also globally
+accessible.
## Class: Buffer
<!-- YAML
diff --git a/doc/api/modules.md b/doc/api/modules.md
index 76d6185885..3d27244fac 100644
--- a/doc/api/modules.md
+++ b/doc/api/modules.md
@@ -83,9 +83,9 @@ by checking `require.main.filename`.
<!-- type=misc -->
The semantics of Node.js's `require()` function were designed to be general
-enough to support a number of reasonable directory structures. Package manager
-programs such as `dpkg`, `rpm`, and `npm` will hopefully find it possible to
-build native packages from Node.js modules without modification.
+enough to support reasonable directory structures. Package manager programs
+such as `dpkg`, `rpm`, and `npm` will hopefully find it possible to build
+native packages from Node.js modules without modification.
Below we give a suggested directory structure that could work:
diff --git a/doc/api/os.md b/doc/api/os.md
index 6f22098f98..75a08dcfbf 100644
--- a/doc/api/os.md
+++ b/doc/api/os.md
@@ -4,8 +4,8 @@
> Stability: 2 - Stable
-The `os` module provides a number of operating system-related utility methods.
-It can be accessed using:
+The `os` module provides operating system-related utility methods. It can be
+accessed using:
```js
const os = require('os');
diff --git a/doc/api/util.md b/doc/api/util.md
index c87957b107..a38288d458 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -1108,11 +1108,10 @@ The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.
added: v10.0.0
-->
-`util.types` provides a number of type checks for different kinds of built-in
-objects. Unlike `instanceof` or `Object.prototype.toString.call(value)`,
-these checks do not inspect properties of the object that are accessible from
-JavaScript (like their prototype), and usually have the overhead of
-calling into C++.
+`util.types` provides type checks for different kinds of built-in objects.
+Unlike `instanceof` or `Object.prototype.toString.call(value)`, these checks do
+not inspect properties of the object that are accessible from JavaScript (like
+their prototype), and usually have the overhead of calling into C++.
The result generally does not make any guarantees about what kinds of
properties or behavior a value exposes in JavaScript. They are primarily