Skip to content

Commit

Permalink
Merge branch '2.0' into 2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverryan committed Nov 16, 2013
2 parents f96f821 + 88065b0 commit ed0f3fd
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions contributing/documentation/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Sphinx
shorthand);
* Inline hyperlinks are **not** used. Seperate the link and their target
definition, which you add on the bottom of the page;
* Inline markup should be closed on the same line as the open-string;
* You should use a form of *you* instead of *we*.

Example
Expand All @@ -26,8 +27,8 @@ Example
Example
=======
When you are working on the docs, you should follow the `Symfony Docs`_
standards.
When you are working on the docs, you should follow the
`Symfony Documentation`_ standards.
Level 2
-------
Expand All @@ -43,7 +44,7 @@ Example
echo 'You cannot use the :: shortcut here';
.. _`Symfony Docs`: http://symfony.com/doc/current/contributing/documentation/standards.html
.. _`Symfony Documentation`: http://symfony.com/doc/current/contributing/documentation/standards.html
Code Examples
-------------
Expand All @@ -60,6 +61,11 @@ Code Examples
* Description of the folded code: (optional)
If you fold several lines: the description of the fold can be placed after the ``...``
If you fold only part of a line: the description can be placed before the line;
* If useful to the reader, a PHP code example should start with the namespace
declaration;
* When referencing classes, be sure to show the ``use`` statements at the
top of your code block. You don't need to show *all* ``use`` statements
in every example, just show what is actually being used in the code block;
* If useful, a ``codeblock`` should begin with a comment containing the filename
of the file in the code block. Don't place a blank line after this comment,
unless the next line is also a comment;
Expand All @@ -82,8 +88,11 @@ Example
.. code-block:: php
// src/Foo/Bar.php
namespace Foo;
use Acme\Demo\Cat;
// ...
class Bar
{
// ...
Expand All @@ -93,9 +102,11 @@ Example
// set foo with a value of bar
$foo = ...;
$cat = new Cat($foo);
// ... check if $bar has the correct value
return $foo->baz($bar, ...);
return $cat->baz($bar, ...);
}
}
Expand Down

0 comments on commit ed0f3fd

Please sign in to comment.