Skip to content

Commit 70d025f

Browse files
Trottcodebytere
authored andcommitted
doc: standardize on sentence case for headers
Previously, our documentation headers were a mixture of title case, sentence case, and things that were neither. For technical documentation, the _de facto_ standard seems to be sentence case. (See refs below.) So let's standardize on that. This commit follows a commit implementing this standard. This commit adds it to the style guide. Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization PR-URL: #33889 Backport-PR-URL: #33964 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 3e68d21 commit 70d025f

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/guides/doc-style-guide.md

+3
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@
6262
* NOT OK: It is important to note that, in all cases, the return value will be
6363
a string regardless.
6464
<!-- lint enable prohibited-strings remark-lint-->
65+
* For headings, use sentence case, not title case.
66+
* OK: _## Everybody to the limit_
67+
* NOT OK: _## Everybody To The Limit_
6568

6669
See also API documentation structure overview in [doctools README][].
6770

0 commit comments

Comments
 (0)