Skip to content

Commit c10d37f

Browse files
committed
Merge pull request #3149 from symfony/language-standards
Clarifying some language standards for the docs
2 parents 9894a72 + 40241af commit c10d37f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

contributing/documentation/standards.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Sphinx
1616
shorthand);
1717
* Inline hyperlinks are **not** used. Separate the link and their target
1818
definition, which you add on the bottom of the page;
19-
* You should use a form of *you* instead of *we*.
2019

2120
Example
2221
~~~~~~~
@@ -104,5 +103,17 @@ Example
104103
In Yaml you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
105104
but this should not be done in Twig (e.g. ``{'hello' : 'value'}``).
106105

106+
Language Standards
107+
------------------
108+
109+
* For sections, use the following rule for capitalization:
110+
`Capitalization of the first word, and all other words, except for closed-class words`_:
111+
The Vitamins are in my Fresh California Raisins
112+
* Do not use `Serial (Oxford) Commas`_;
113+
* You should use a form of *you* instead of *we* (i.e. avoid the first person
114+
point of view: use the second instead).
115+
107116
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
108117
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html
118+
.. _`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
119+
.. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma

0 commit comments

Comments
 (0)