From b49d2aad2afe25665d389c2a8d9fbd934d10ec73 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 8 May 2019 22:12:15 -0700 Subject: doc: simplify About This Documentation text Remove some unnecessary words and simplify some phrases in documentation.md. PR-URL: https://github.com/nodejs/node/pull/27619 Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- doc/api/documentation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'doc/api/documentation.md') diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 440f21c7af0..d32af91a023 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -3,7 +3,7 @@ -The goal of this documentation is to comprehensively explain the Node.js +The goal of this documentation is to explain the Node.js API, both from a reference as well as a conceptual point of view. Each section describes a built-in module or high-level concept. @@ -30,7 +30,7 @@ stability. The Node.js API is still somewhat changing, and as it matures, certain parts are more reliable than others. Some 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 -and in the process of being redesigned. +and being redesigned. The stability indices are as follows: @@ -50,13 +50,13 @@ The stability indices are as follows: > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high > priority. -Caution must be used when making use of `Experimental` features, particularly -within modules that may be used as dependencies (or dependencies of +Use caution when making use of `Experimental` features, particularly +within modules that are dependencies (or dependencies of dependencies) within a Node.js application. End users may not be aware that -experimental features are being used, and therefore may experience unexpected +experimental features are being used, and may experience unexpected failures or behavior changes when API modifications occur. To help avoid such surprises, `Experimental` features may require a command-line flag to -explicitly enable them, or may cause a process warning to be emitted. +enable them, or may emit a process warning. By default, such warnings are printed to [`stderr`][] and may be handled by attaching a listener to the [`'warning'`][] event. @@ -76,7 +76,7 @@ wish to do programmatic things with the documentation. System calls like open(2) and read(2) define the interface between user programs and the underlying operating system. Node.js functions -which simply wrap a syscall, +which wrap a syscall, like [`fs.open()`][], will document that. The docs link to the corresponding man pages (short for manual pages) which describe how the syscalls work. -- cgit v1.2.3