Skip to content

Commit 172fa63

Browse files
Trotttargos
authored andcommitted
doc: simplify About This Documentation text
Remove some unnecessary words and simplify some phrases in documentation.md. PR-URL: #27619 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 3801859 commit 172fa63

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/documentation.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--introduced_in=v0.10.0-->
44
<!-- type=misc -->
55

6-
The goal of this documentation is to comprehensively explain the Node.js
6+
The goal of this documentation is to explain the Node.js
77
API, both from a reference as well as a conceptual point of view. Each
88
section describes a built-in module or high-level concept.
99

@@ -30,7 +30,7 @@ stability. The Node.js API is still somewhat changing, and as it
3030
matures, certain parts are more reliable than others. Some are so
3131
proven, and so relied upon, that they are unlikely to ever change at
3232
all. Others are brand new and experimental, or known to be hazardous
33-
and in the process of being redesigned.
33+
and being redesigned.
3434

3535
The stability indices are as follows:
3636

@@ -50,13 +50,13 @@ The stability indices are as follows:
5050
> Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
5151
> priority.
5252
53-
Caution must be used when making use of `Experimental` features, particularly
54-
within modules that may be used as dependencies (or dependencies of
53+
Use caution when making use of `Experimental` features, particularly
54+
within modules that are dependencies (or dependencies of
5555
dependencies) within a Node.js application. End users may not be aware that
56-
experimental features are being used, and therefore may experience unexpected
56+
experimental features are being used, and may experience unexpected
5757
failures or behavior changes when API modifications occur. To help avoid such
5858
surprises, `Experimental` features may require a command-line flag to
59-
explicitly enable them, or may cause a process warning to be emitted.
59+
enable them, or may emit a process warning.
6060
By default, such warnings are printed to [`stderr`][] and may be handled by
6161
attaching a listener to the [`'warning'`][] event.
6262

@@ -76,7 +76,7 @@ wish to do programmatic things with the documentation.
7676

7777
System calls like open(2) and read(2) define the interface between user programs
7878
and the underlying operating system. Node.js functions
79-
which simply wrap a syscall,
79+
which wrap a syscall,
8080
like [`fs.open()`][], will document that. The docs link to the corresponding man
8181
pages (short for manual pages) which describe how the syscalls work.
8282

0 commit comments

Comments
 (0)