From 756acd087742939873555ca397f7b33e0db8a9ae Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 6 Apr 2024 23:46:29 -0700 Subject: [PATCH] doc: use consistent plural form of "index" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Our documentation uses both "indices" and "indexes" as the plural form of "index". The Microsoft Style Guide, which we've adopted for documentation, says to use "indexes" so let's standardize on that. Ref: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/i/index-indexes-indices PR-URL: https://github.com/nodejs/node/pull/52373 Refs: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/i/index-indexes-indices Reviewed-By: Antoine du Hamel Reviewed-By: Filip Skokan Reviewed-By: Anna Henningsen Reviewed-By: Yagiz Nizipli Reviewed-By: Luigi Pinca Reviewed-By: Ulises Gascón Reviewed-By: Benjamin Gruenbaum --- doc/api/buffer.md | 6 +++--- doc/api/dgram.md | 4 ++-- doc/api/documentation.md | 2 +- doc/api/events.md | 2 +- doc/api/n-api.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 7bb7d42454fad6..24211303e1594e 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -2224,7 +2224,7 @@ added: v1.1.0 * Returns: {Iterator} -Creates and returns an [iterator][] of `buf` keys (indices). +Creates and returns an [iterator][] of `buf` keys (indexes). ```mjs import { Buffer } from 'node:buffer'; @@ -3343,7 +3343,7 @@ added: v3.0.0 * Returns: {Buffer} Returns a new `Buffer` that references the same memory as the original, but -offset and cropped by the `start` and `end` indices. +offset and cropped by the `start` and `end` indexes. Specifying `end` greater than [`buf.length`][] will return the same result as that of `end` equal to [`buf.length`][]. @@ -3470,7 +3470,7 @@ changes: > Stability: 0 - Deprecated: Use [`buf.subarray`][] instead. Returns a new `Buffer` that references the same memory as the original, but -offset and cropped by the `start` and `end` indices. +offset and cropped by the `start` and `end` indexes. This method is not compatible with the `Uint8Array.prototype.slice()`, which is a superclass of `Buffer`. To copy the slice, use diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 65d4a9f678cbd2..26e01f100258f0 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -741,7 +741,7 @@ added: v8.6.0 * `multicastInterface` {string} _All references to scope in this section are referring to -[IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP +[IPv6 Zone Indexes][], which are defined by [RFC 4007][]. In string form, an IP with a scope index is written as `'IP%scope'` where scope is an interface name or interface number._ @@ -988,7 +988,7 @@ interfaces" address on a random port (it does the right thing for both `udp4` and `udp6` sockets). The bound address and port can be retrieved using [`socket.address().address`][] and [`socket.address().port`][]. -[IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses +[IPv6 Zone Indexes]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses [RFC 4007]: https://tools.ietf.org/html/rfc4007 [`'close'`]: #event-close [`ERR_SOCKET_BAD_PORT`]: errors.md#err_socket_bad_port diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 6adbdc11ade031..edac7426fe0324 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -21,7 +21,7 @@ Throughout the documentation are indications of a section's stability. Some APIs are so proven and so relied upon that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous. -The stability indices are as follows: +The stability indexes are as follows: > Stability: 0 - Deprecated. The feature may emit warnings. Backward > compatibility is not guaranteed. diff --git a/doc/api/events.md b/doc/api/events.md index febe3adc63b070..8ec82db04c25da 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -962,7 +962,7 @@ myEmitter.emit('event'); ``` Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered _after_ the listener +change the position indexes of any listener registered _after_ the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the `emitter.listeners()` method will need to be recreated. diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 1ccc1795cd84c0..826d5b09e37852 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -2218,9 +2218,9 @@ typedef enum { } napi_key_conversion; ``` -`napi_key_numbers_to_strings` will convert integer indices to +`napi_key_numbers_to_strings` will convert integer indexes to strings. `napi_key_keep_numbers` will return numbers for integer -indices. +indexes. #### `napi_valuetype`