diff options
| author | Alexey Orlenko <eaglexrlnk@gmail.com> | 2017-05-20 16:15:58 -0400 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-05-25 18:49:41 -0400 |
| commit | 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d (patch) | |
| tree | d0ba4f62fff9db7d42b3f86c7358d9219b288698 /doc/api/modules.md | |
| parent | b3d1e3d4c720729c8f14e413a285660547ee677a (diff) | |
| download | android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.gz android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.bz2 android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.zip | |
doc: make the style of notes consistent
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/api/modules.md')
| -rw-r--r-- | doc/api/modules.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/api/modules.md b/doc/api/modules.md index d09e58f5cb..adbefb8120 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -348,9 +348,9 @@ If this was in a folder at `./some-library`, then This is the extent of Node.js's awareness of package.json files. -Note: If the file specified by the `"main"` entry of `package.json` is missing -and can not be resolved, Node.js will report the entire module as missing with -the default error: +*Note*: If the file specified by the `"main"` entry of `package.json` is +missing and can not be resolved, Node.js will report the entire module as +missing with the default error: ```txt Error: Cannot find module 'some-library' @@ -401,8 +401,9 @@ same module resolution semantics. If the `NODE_PATH` environment variable is set to a colon-delimited list of absolute paths, then Node.js will search those paths for modules if they -are not found elsewhere. (Note: On Windows, `NODE_PATH` is delimited by -semicolons instead of colons.) +are not found elsewhere. + +*Note*: On Windows, `NODE_PATH` is delimited by semicolons instead of colons. `NODE_PATH` was originally created to support loading modules from varying paths before the current [module resolution][] algorithm was frozen. @@ -627,10 +628,10 @@ added: v0.5.1 The `module.require` method provides a way to load a module as if `require()` was called from the original module. -*Note*: In order to do this, it is necessary to get a reference to the `module` -object. Since `require()` returns the `module.exports`, and the `module` is -typically *only* available within a specific module's code, it must be -explicitly exported in order to be used. +*Note*: In order to do this, it is necessary to get a reference to the +`module` object. Since `require()` returns the `module.exports`, and the +`module` is typically *only* available within a specific module's code, it must +be explicitly exported in order to be used. [`Error`]: errors.html#errors_class_error [module resolution]: #modules_all_together |