From a56e78c8c83f0490a5384c39a4394b9c74004858 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 23 Oct 2019 15:35:13 -0700 Subject: [PATCH] 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.. PR-URL: https://github.com/nodejs/node/pull/30103 Reviewed-By: Colin Ihrig Reviewed-By: David Carlier Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/addons.md | 28 +++++++++++++--------------- doc/api/dgram.md | 7 +++---- doc/api/globals.md | 6 +++--- doc/api/modules.md | 6 +++--- doc/api/os.md | 4 ++-- doc/api/util.md | 9 ++++----- 6 files changed, 28 insertions(+), 32 deletions(-) diff --git a/doc/api/addons.md b/doc/api/addons.md index 6b440bf6746b96..774be1a7aaab83 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 — 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 `) 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 `) 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 cf007e5b587357..ed7adac4030744 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -589,8 +589,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) 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 6f22098f985332..75a08dcfbfe087 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 1ba0505b189b6f..6435709bd84331 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1107,11 +1107,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