diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-05-30 07:56:48 +0000 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2018-06-06 10:31:28 +0200 |
| commit | 29c35bd0deba068a0bdd02a63adfb56020216491 (patch) | |
| tree | 657f5f2c4633e520d847455ccb63adfeed82be6a /doc/STYLE_GUIDE.md | |
| parent | a30bf55e69433bf5fea0f75f93fd28c5c2e96c52 (diff) | |
| download | node-new-29c35bd0deba068a0bdd02a63adfb56020216491.tar.gz | |
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.md | 3 |
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 |