Skip to content

Commit

Permalink
Rewords, tweaks and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
javiereguiluz committed Mar 7, 2015
1 parent 598e522 commit 9c44351
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions contributing/documentation/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ Example
Code Examples
-------------

* The code follows the :doc:`Symfony Coding Standards </contributing/code/standards>`
as well as the `Twig Coding Standards`_;
* The code examples should look real for a web application context. Avoid abstract
and puerile examples (``foo``, ``bar``, ``demo``, etc.);
* Use ``Acme`` when the code requires to explicit a vendor name;
* The code should follow the :doc:`Symfony Best Practices </best_practices>`.
or puerile examples (``foo``, ``bar``, ``demo``, etc.);
* The code should follow the :doc:`Symfony Best Practices </best_practices/introduction>`.
Unless the example requires to use a custom bundle, make sure to always use the
``AppBundle`` bundle to store your code;
* The code follows the :doc:`Symfony Coding Standards </contributing/code/standards>`
as well as the `Twig Coding Standards`_;
* Use ``Acme`` when the code requires a vendor name;
* To avoid horizontal scrolling on code blocks, we prefer to break a line
correctly if it crosses the 85th character;
* When you fold one or more lines of code, place ``...`` in a comment at the point
Expand Down Expand Up @@ -145,13 +145,9 @@ English Language Standards
--------------------------

Symfony documentation uses the United States English dialect, commonly called
`American English`_.

Unlike most popular languages, the English language doesn't have a central
language authority and there is no official grammar or dictionary. Symfony
documentation uses the `American English Oxford Dictionary`_ to resolve disputes
over common words. In case a technical word isn't included in the dictionary yet,
Symfony Documentation maintainers will decide over the disputes.
`American English`_. Disputes over vocabulary will always be resolved using the
`American English Oxford Dictionary`_ reference. Disputes over neologisms not
included yet in the dictionary will be resolved by Symfony Documentation maintainers.

In addition, documentation contents should follow these rules:

Expand Down

0 comments on commit 9c44351

Please sign in to comment.