diff options
| author | Rich Trott <rtrott@gmail.com> | 2017-11-18 14:09:05 -0800 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2017-11-22 08:24:41 -0800 |
| commit | e577d7dbc98afbf587cb92990a4f0bcc85d5b22e (patch) | |
| tree | 8067dcd405e773bb7950f22b242c2400dcc8063b /doc/STYLE_GUIDE.md | |
| parent | a3a987b4b80ec680fd2ffa7ab9f4aae4c3abaab5 (diff) | |
| download | android-node-v8-e577d7dbc98afbf587cb92990a4f0bcc85d5b22e.tar.gz android-node-v8-e577d7dbc98afbf587cb92990a4f0bcc85d5b22e.tar.bz2 android-node-v8-e577d7dbc98afbf587cb92990a4f0bcc85d5b22e.zip | |
doc: add capitalization styling to STYLE_GUIDE
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.
PR-URL: https://github.com/nodejs/node/pull/17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 923cbb5100..9cdbf0d7b6 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -69,6 +69,9 @@ * Function returns should use the following format: * <code>* Returns: {type|type2} Optional description.</code> * E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code> +* Use official styling for capitalization in products and projects. + * OK: JavaScript, Google's V8 + * NOT OK: Javascript, Google's v8 [Em dashes]: https://en.wikipedia.org/wiki/Dash#Em_dash [Javascript type]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#Data_structures_and_types |