Skip to content

Commit 9c44351

Browse files
committed
Rewords, tweaks and fixes
1 parent 598e522 commit 9c44351

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

contributing/documentation/standards.rst

+8-12
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,14 @@ Example
4949
Code Examples
5050
-------------
5151

52+
* The code follows the :doc:`Symfony Coding Standards </contributing/code/standards>`
53+
as well as the `Twig Coding Standards`_;
5254
* 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>`.
55+
or puerile examples (``foo``, ``bar``, ``demo``, etc.);
56+
* The code should follow the :doc:`Symfony Best Practices </best_practices/introduction>`.
5657
Unless the example requires to use a custom bundle, make sure to always use the
5758
``AppBundle`` bundle to store your code;
58-
* The code follows the :doc:`Symfony Coding Standards </contributing/code/standards>`
59-
as well as the `Twig Coding Standards`_;
59+
* Use ``Acme`` when the code requires a vendor name;
6060
* To avoid horizontal scrolling on code blocks, we prefer to break a line
6161
correctly if it crosses the 85th character;
6262
* When you fold one or more lines of code, place ``...`` in a comment at the point
@@ -145,13 +145,9 @@ English Language Standards
145145
--------------------------
146146

147147
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.
148+
`American English`_. Disputes over vocabulary will always be resolved using the
149+
`American English Oxford Dictionary`_ reference. Disputes over neologisms not
150+
included yet in the dictionary will be resolved by Symfony Documentation maintainers.
155151

156152
In addition, documentation contents should follow these rules:
157153

0 commit comments

Comments
 (0)