mirror of https://github.com/nodejs/node.git
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>pull/21085/merge
parent
6cda5a98fd
commit
c524576a6f
|
@ -26,8 +26,7 @@
|
||||||
fragment of a clause.
|
fragment of a clause.
|
||||||
* Place end-of-sentence punctuation inside wrapping elements — periods go
|
* Place end-of-sentence punctuation inside wrapping elements — periods go
|
||||||
inside parentheses and quotes, not after.
|
inside parentheses and quotes, not after.
|
||||||
* Documents must start with a level-one heading. An example document will be
|
* Documents must start with a level-one heading.
|
||||||
linked here eventually.
|
|
||||||
* Prefer affixing links to inlining links — prefer `[a link][]` to
|
* Prefer affixing links to inlining links — prefer `[a link][]` to
|
||||||
`[a link](http://example.com)`.
|
`[a link](http://example.com)`.
|
||||||
* When documenting APIs, note the version the API was introduced in at
|
* When documenting APIs, note the version the API was introduced in at
|
||||||
|
|
Loading…
Reference in New Issue