Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-05-09 08:12:15 +0300
committerRich Trott <rtrott@gmail.com>2019-05-11 11:14:05 +0300
commitb49d2aad2afe25665d389c2a8d9fbd934d10ec73 (patch)
treef6fd8bc218d1b063dcaecc7422bb420c65158326 /doc/api/documentation.md
parentac56dc96e32a4f9468c869fc5af293129c20a6cd (diff)
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 <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/documentation.md')
-rw-r--r--doc/api/documentation.md14
1 files changed, 7 insertions, 7 deletions
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 @@
<!--introduced_in=v0.10.0-->
<!-- type=misc -->
-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.