summaryrefslogtreecommitdiff
path: root/doc/STYLE_GUIDE.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-05-30 07:56:48 +0000
committerRich Trott <rtrott@gmail.com>2018-06-02 00:25:36 +0200
commitc524576a6fed0ac112ac162d220e7d86f218aaec (patch)
tree416a793cd0c4523c1e4d9132bad36aa1500d949b /doc/STYLE_GUIDE.md
parent6cda5a98fd1aaedb23d39644a0c95ce1e52e1223 (diff)
downloadandroid-node-v8-c524576a6fed0ac112ac162d220e7d86f218aaec.tar.gz
android-node-v8-c524576a6fed0ac112ac162d220e7d86f218aaec.tar.bz2
android-node-v8-c524576a6fed0ac112ac162d220e7d86f218aaec.zip
doc: remove link prediction from STYLE_GUIDE.md
Remove promise to eventually link an example document to show level-one heading. The style guide has been fine without the example doc for a long time. The statement is already clear. And the style guide itself is an example. We don't link to examples of wrapping at 80 characters, for example. There's no need to link just to show what a level-one heading is. (And if level-one heading is unclear, then it may be preferable to improve the terminology rather than to link to an example.) PR-URL: https://github.com/nodejs/node/pull/21031 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
-rw-r--r--doc/STYLE_GUIDE.md3
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md
index a875a31b83..610b012dda 100644
--- a/doc/STYLE_GUIDE.md
+++ b/doc/STYLE_GUIDE.md
@@ -26,8 +26,7 @@
fragment of a clause.
* Place end-of-sentence punctuation inside wrapping elements — periods go
inside parentheses and quotes, not after.
-* Documents must start with a level-one heading. An example document will be
- linked here eventually.
+* Documents must start with a level-one heading.
* Prefer affixing links to inlining links — prefer `[a link][]` to
`[a link](http://example.com)`.
* When documenting APIs, note the version the API was introduced in at