Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Updated documentation standards (code examples and English use)#5064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
weaverryan merged 4 commits intosymfony:2.3fromjaviereguiluz:promote_real_examples
Mar 14, 2015
Merged
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletionscontributing/documentation/standards.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,8 @@ Sphinx
------

* The following characters are chosen for different heading levels: level 1
is ``=``, level 2 ``-``, level 3 ``~``, level 4 ``.`` and level 5 ``"``;
is ``=`` (equal sign), level 2 ``-`` (dash), level 3 ``~`` (tilde), level 4
``.`` (dot) and level 5 ``"`` (double quote);
* Each line should break approximately after the first word that crosses the
72nd character (so most lines end up being 72-78 characters);
* The ``::`` shorthand is *preferred* over ``.. code-block:: php`` to begin a PHP
Expand DownExpand Up@@ -50,6 +51,12 @@ 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
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;
* 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 DownExpand Up@@ -137,8 +144,12 @@ Files and Directories
English Language Standards
--------------------------

* **English Dialect**: use the United States English dialect, commonly called
`American English`_.
Symfony documentation uses the United States English dialect, commonly called
`American English`_. The `American English Oxford Dictionary`_ is used as the
vocabulary reference.

In addition, documentation follows these rules:

* **Section titles**: use a variant of the title case, where the first
word is always capitalized and all other words are capitalized, except for
the closed-class words (read Wikipedia article about `headings and titles`_).
Expand All@@ -160,6 +171,7 @@ English Language Standards
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html
.. _`American English`: http://en.wikipedia.org/wiki/American_English
.. _`American English Oxford Dictionary`: http://www.oxforddictionaries.com/definition/american_english/
.. _`headings and titles`: http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles
.. _`Serial (Oxford) Commas`: http://en.wikipedia.org/wiki/Serial_comma
.. _`nosism`: http://en.wikipedia.org/wiki/Nosism

[8]ページ先頭

©2009-2025 Movatter.jp