From b860a7f61ced68f72b16c1385a0a9bfe29a35591 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 17 Sep 2020 11:58:30 -0700 Subject: [PATCH] doc: standardize on _backward_ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We use _backward incompatible_ and _backwards incompatible_ with no discernible pattern in the docs. Follow Chicago Manual of Style and also our standardization on US English and favor _backward_. PR-URL: https://github.com/nodejs/node/pull/35243 Reviewed-By: Michaël Zasso Reviewed-By: Michael Dawson --- doc/api/cluster.md | 2 +- doc/api/crypto.md | 2 +- doc/api/process.md | 2 +- doc/api/readline.md | 2 +- doc/api/repl.md | 4 ++-- doc/guides/technical-values.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 1ed5e38670fb3c..92e4d42d60e3fd 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -436,7 +436,7 @@ If the graceful disconnect behavior is not needed, use `worker.process.kill()`. Causes `.exitedAfterDisconnect` to be set. -This method is aliased as `worker.destroy()` for backwards compatibility. +This method is aliased as `worker.destroy()` for backward compatibility. In a worker, `process.kill()` exists, but it is not this function; it is [`kill()`][]. diff --git a/doc/api/crypto.md b/doc/api/crypto.md index d4e4e10596e215..329f32bdeb1d80 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1602,7 +1602,7 @@ The default encoding to use for functions that can take either strings or [buffers][`Buffer`]. The default value is `'buffer'`, which makes methods default to [`Buffer`][] objects. -The `crypto.DEFAULT_ENCODING` mechanism is provided for backwards compatibility +The `crypto.DEFAULT_ENCODING` mechanism is provided for backward compatibility with legacy programs that expect `'latin1'` to be the default encoding. New applications should expect the default to be `'buffer'`. diff --git a/doc/api/process.md b/doc/api/process.md index 385f0c30feb4eb..03733b2c7e8e4c 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2320,7 +2320,7 @@ important ways: * Pipes (and sockets): *synchronous* on Windows, *asynchronous* on POSIX These behaviors are partly for historical reasons, as changing them would -create backwards incompatibility, but they are also expected by some users. +create backward incompatibility, but they are also expected by some users. Synchronous writes avoid problems such as output written with `console.log()` or `console.error()` being unexpectedly interleaved, or not written at all if diff --git a/doc/api/readline.md b/doc/api/readline.md index af5e3147d41f4d..8d3eef1ab42aee 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -828,7 +828,7 @@ const { createInterface } = require('readline'); ctrl + w or ctrl + backspace - Delete backwards to a word boundary + Delete backward to a word boundary ctrl + backspace Doesn't work on Linux, Mac and Windows diff --git a/doc/api/repl.md b/doc/api/repl.md index 8f3f6c41c5b2b7..fe8115a9536377 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -246,8 +246,8 @@ added: v13.6.0 --> The REPL supports bi-directional reverse-i-search similar to [ZSH][]. It is -triggered with ` + R` to search backwards and ` + S` to search -forwards. +triggered with ` + R` to search backward and ` + S` to search +forward. Duplicated history entires will be skipped. diff --git a/doc/guides/technical-values.md b/doc/guides/technical-values.md index a688c0b21fe412..d79fde6a461021 100644 --- a/doc/guides/technical-values.md +++ b/doc/guides/technical-values.md @@ -26,7 +26,7 @@ with Node.js. Some key elements of this include: Whenever possible, we seek to ensure that working code continues to work. To keep the trust of developers and users, we value stability. Some key elements of this include: -* Backwards compatibility +* Backward compatibility * Stable releases on a predictable schedule * A strong safety net, including testing how changes in Node.js affect popular packages