88------
99
1010* The following characters are chosen for different heading levels: level 1
11- is ``= ``, level 2 ``- ``, level 3 ``~ ``, level 4 ``. `` and level 5 ``" ``;
11+ is ``= `` (equal sign), level 2 ``- `` (dash), level 3 ``~ `` (tilde), level 4
12+ ``. `` (dot) and level 5 ``" `` (double quote);
1213* Each line should break approximately after the first word that crosses the
1314 72nd character (so most lines end up being 72-78 characters);
1415* The ``:: `` shorthand is *preferred * over ``.. code-block:: php `` to begin a PHP
@@ -48,6 +49,12 @@ Example
4849 Code Examples
4950-------------
5051
52+ * The code examples should look real for a web application context. Avoid abstract
53+ and puerile examples (``foo ``, ``bar ``, ``demo ``, etc.);
54+ * Use ``Acme `` when the code requires to explicit a vendor name;
55+ * The code should follow the :doc: `Symfony Best Practices </best_practices >`.
56+ Unless the example requires to use a custom bundle, make sure to always use the
57+ ``AppBundle `` bundle to store your code;
5158* The code follows the :doc: `Symfony Coding Standards </contributing/code/standards >`
5259 as well as the `Twig Coding Standards `_;
5360* To avoid horizontal scrolling on code blocks, we prefer to break a line
@@ -137,8 +144,17 @@ Files and Directories
137144 English Language Standards
138145--------------------------
139146
140- * **English Dialect **: use the United States English dialect, commonly called
141- `American English `_.
147+ Symfony documentation uses the United States English dialect, commonly called
148+ `American English `_.
149+
150+ Unlike most popular languages, the English language doesn't have a central
151+ language authority and there is no official grammar or dictionary. Symfony
152+ documentation uses the `American English Oxford Dictionary `_ to resolve disputes
153+ over common words. In case a technical word isn't included in the dictionary yet,
154+ Symfony Documentation maintainers will decide over the disputes.
155+
156+ In addition, documentation contents should follow these rules:
157+
142158* **Section titles **: use a variant of the title case, where the first
143159 word is always capitalized and all other words are capitalized, except for
144160 the closed-class words (read Wikipedia article about `headings and titles `_).
@@ -160,6 +176,7 @@ English Language Standards
160176.. _`the Sphinx documentation` : http://sphinx-doc.org/rest.html#source-code
161177.. _`Twig Coding Standards` : http://twig.sensiolabs.org/doc/coding_standards.html
162178.. _`American English` : http://en.wikipedia.org/wiki/American_English
179+ .. _`American English Oxford Dictionary` : http://www.oxforddictionaries.com/
163180.. _`headings and titles` : http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles
164181.. _`Serial (Oxford) Commas` : http://en.wikipedia.org/wiki/Serial_comma
165182.. _`nosism` : http://en.wikipedia.org/wiki/Nosism
0 commit comments