summaryrefslogtreecommitdiff
path: root/doc/STYLE_GUIDE.md
diff options
context:
space:
mode:
authorDenys Otrishko <shishugi@gmail.com>2018-10-26 19:27:40 +0300
committerGeorge Adams <george.adams@uk.ibm.com>2018-10-29 21:24:08 +0000
commitf90cf19fdd729cff6147b12be191effa6113712e (patch)
tree26f3c1706954788e68cfb490087d7a8810adb92a /doc/STYLE_GUIDE.md
parentd7b95f1fe45ea1d62b133ebe8f9c55094738d51d (diff)
downloadandroid-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.tar.gz
android-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.tar.bz2
android-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.zip
doc: remove notice of dashes in V8 options
Previously only V8 options supported both dashes in them (making them equivalent), but now Node.js also supports both styles so the note can be removed. PR-URL: https://github.com/nodejs/node/pull/23903 Refs: https://github.com/nodejs/node/pull/18592 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
-rw-r--r--doc/STYLE_GUIDE.md4
1 files changed, 0 insertions, 4 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md
index 6d41a77e91..bb7af3f7ec 100644
--- a/doc/STYLE_GUIDE.md
+++ b/doc/STYLE_GUIDE.md
@@ -51,10 +51,6 @@
* References to constructor instances should use camelCase.
* References to methods should be used with parentheses: for example,
`socket.end()` instead of `socket.end`.
-* To draw special attention to a note, adhere to the following guidelines:
- * Make the "Note:" label italic, i.e. `*Note*:`.
- * Use a capital letter after the "Note:" label.
- * Preferably, make the note a new paragraph for better visual distinction.
* Function arguments or object properties should use the following format:
* ``` * `name` {type|type2} Optional description. **Default:** `value`. ```
<!--lint disable maximum-line-length remark-lint-->