Skip to content

Commit 29c35bd

Browse files
TrottMylesBorins
authored andcommitted
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: #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>
1 parent a30bf55 commit 29c35bd

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

doc/STYLE_GUIDE.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
fragment of a clause.
2727
* Place end-of-sentence punctuation inside wrapping elements — periods go
2828
inside parentheses and quotes, not after.
29-
* Documents must start with a level-one heading. An example document will be
30-
linked here eventually.
29+
* Documents must start with a level-one heading.
3130
* Prefer affixing links to inlining links — prefer `[a link][]` to
3231
`[a link](http://example.com)`.
3332
* When documenting APIs, note the version the API was introduced in at

0 commit comments

Comments
 (0)