From c3816f8280f86bbb37a4086e330a623de3e94f27 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sun, 3 Nov 2013 13:11:42 -0600 Subject: [PATCH 1/3] Clarifying some language standards for the docs --- contributing/documentation/standards.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index fca5515fb89..0a59b2dbbee 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -16,7 +16,6 @@ Sphinx shorthand); * Inline hyperlinks are **not** used. Separate the link and their target definition, which you add on the bottom of the page; -* You should use a form of *you* instead of *we*. Example ~~~~~~~ @@ -104,5 +103,14 @@ Example In Yaml you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``), but this should not be done in Twig (e.g. ``{'hello' : 'value'}``). +Language Standards +------------------ + +* Capitalize the first letter of any heading and the first letter of all + nouns and adjectives afterwards (verbs are lowercase); +* Do not use `Serial (Oxford) Commas`_; +* You should use a form of *you* instead of *we*. + .. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code .. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html +.. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma \ No newline at end of file From ec0981ddd769030295ba0a9a358f3e7e50b85442 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sat, 9 Nov 2013 12:40:46 -0500 Subject: [PATCH 2/3] [#3149] Tweaks thanks to @WouterJ --- contributing/documentation/standards.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 0a59b2dbbee..7e69de097fa 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -109,8 +109,9 @@ Language Standards * Capitalize the first letter of any heading and the first letter of all nouns and adjectives afterwards (verbs are lowercase); * Do not use `Serial (Oxford) Commas`_; -* You should use a form of *you* instead of *we*. +* You should use a form of *you* instead of *we* (i.e. avoid the first person + point of view: use the second instead). .. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code .. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html -.. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma \ No newline at end of file +.. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma From 40241af8fd6bfb23a3e8179ee830f3cf6184940f Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sat, 9 Nov 2013 12:46:09 -0500 Subject: [PATCH 3/3] [#3149] Tweaking language to use a standard for capitalization --- contributing/documentation/standards.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 7e69de097fa..3750f13c268 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -106,12 +106,14 @@ Example Language Standards ------------------ -* Capitalize the first letter of any heading and the first letter of all - nouns and adjectives afterwards (verbs are lowercase); +* For sections, use the following rule for capitalization: + `Capitalization of the first word, and all other words, except for closed-class words`_: + The Vitamins are in my Fresh California Raisins * Do not use `Serial (Oxford) Commas`_; * You should use a form of *you* instead of *we* (i.e. avoid the first person point of view: use the second instead). .. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code .. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html +.. _`Capitalization of the first word, and all other words, except for closed-class words`: http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles .. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma