From c524576a6fed0ac112ac162d220e7d86f218aaec Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 30 May 2018 07:56:48 +0000 Subject: [PATCH] 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 Reviewed-By: Vse Mozhet Byt Reviewed-By: Tiancheng "Timothy" Gu Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Trivikram Kamat --- doc/STYLE_GUIDE.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index a875a31b83d14a..610b012dda5570 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