From 70d025f510715978340e2120deab337587881757 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 14 Jun 2020 22:51:06 -0700 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/33889 Backport-PR-URL: https://github.com/nodejs/node/pull/33964 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/guides/doc-style-guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index fad23941416713..6c67e752bfc394 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -62,6 +62,9 @@ * NOT OK: It is important to note that, in all cases, the return value will be a string regardless. +* For headings, use sentence case, not title case. + * OK: _## Everybody to the limit_ + * NOT OK: _## Everybody To The Limit_ See also API documentation structure overview in [doctools README][].