diff --git a/doc/api/documentation.md b/doc/api/documentation.md index d17fe35c2a2ed7..312084379481c8 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 -API, both from a reference as well as a conceptual point of view. Each +API, both from a reference as well as a conceptual point of view. Each section describes a built-in module or high-level concept. Where appropriate, property types, method arguments, and the arguments @@ -11,12 +11,12 @@ provided to event handlers are detailed in a list underneath the topic heading. Every `.html` document has a corresponding `.json` document presenting -the same information in a structured manner. This feature is +the same information in a structured manner. This feature is experimental, and added for the benefit of IDEs and other utilities that wish to do programmatic things with the documentation. Every `.html` and `.json` file is generated based on the corresponding -`.md` file in the `doc/api/` folder in Node.js's source tree. The +`.md` file in the `doc/api/` folder in Node.js's source tree. The documentation is generated using the `tools/doc/generate.js` program. The HTML template is located at `doc/template.html`. @@ -39,15 +39,18 @@ The stability indices are as follows: ```txt Stability: 0 - Deprecated -This feature is known to be problematic, and changes are -planned. Do not rely on it. Use of the feature may cause warnings. Backwards -compatibility should not be expected. +This feature is known to be problematic, and changes are planned. Do +not rely on it. Use of the feature may cause warnings to be emitted. +Backwards compatibility should not be expected. ``` ```txt Stability: 1 - Experimental -This feature is subject to change, and is gated by a command line flag. -It may change or be removed in future versions. +This feature is still under active development and subject to non-backwards +compatible changes, or even removal, in any future version. Use of the feature +is not recommended in production environments. The feature may only be usable +only after using a command-line flag to enable it. Use of the feature may cause +warnings to be emitted. ``` ```txt @@ -63,7 +66,7 @@ is a high priority, and will not be broken unless absolutely necessary. Every HTML file in the markdown has a corresponding JSON file with the same data. -This feature was added in Node.js v0.6.12. It is experimental. +This feature was added in Node.js v0.6.12. It is experimental. ## Syscalls and man pages @@ -72,7 +75,7 @@ and the underlying operating system. Node functions which simply 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. -**Caveat:** some syscalls, like lchown(2), are BSD-specific. That means, for +**Note:** some syscalls, like lchown(2), are BSD-specific. That means, for example, that `fs.lchown()` only works on macOS and other BSD-derived systems, and is not available on Linux.