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

Commited0f3fd

Browse files
committed
Merge branch '2.0' into 2.1
2 parentsf96f821 +88065b0 commited0f3fd

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

‎contributing/documentation/standards.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Sphinx
1616
shorthand);
1717
* Inline hyperlinks are **not** used. Seperate the link and their target
1818
definition, which you add on the bottom of the page;
19+
* Inline markup should be closed on the same line as the open-string;
1920
* You should use a form of *you* instead of *we*.
2021

2122
Example
@@ -26,8 +27,8 @@ Example
2627
Example
2728
=======
2829
29-
When you are working on the docs, you should follow the `Symfony Docs`_
30-
standards.
30+
When you are working on the docs, you should follow the
31+
`Symfony Documentation`_standards.
3132
3233
Level 2
3334
-------
@@ -43,7 +44,7 @@ Example
4344
4445
echo 'You cannot use the :: shortcut here';
4546
46-
.. _`SymfonyDocs`: http://symfony.com/doc/current/contributing/documentation/standards.html
47+
.. _`SymfonyDocumentation`: http://symfony.com/doc/current/contributing/documentation/standards.html
4748
4849
Code Examples
4950
-------------
@@ -60,6 +61,11 @@ Code Examples
6061
* Description of the folded code: (optional)
6162
If you fold several lines: the description of the fold can be placed after the ``...``
6263
If you fold only part of a line: the description can be placed before the line;
64+
* If useful to the reader, a PHP code example should start with the namespace
65+
declaration;
66+
* When referencing classes, be sure to show the ``use`` statements at the
67+
top of your code block. You don't need to show *all* ``use`` statements
68+
in every example, just show what is actually being used in the code block;
6369
* If useful, a ``codeblock`` should begin with a comment containing the filename
6470
of the file in the code block. Don't place a blank line after this comment,
6571
unless the next line is also a comment;
@@ -82,8 +88,11 @@ Example
8288
..code-block::php
8389
8490
// src/Foo/Bar.php
91+
namespace Foo;
8592
93+
use Acme\Demo\Cat;
8694
// ...
95+
8796
class Bar
8897
{
8998
// ...
@@ -93,9 +102,11 @@ Example
93102
// set foo with a value of bar
94103
$foo = ...;
95104
105+
$cat = new Cat($foo);
106+
96107
// ... check if $bar has the correct value
97108
98-
return $foo->baz($bar, ...);
109+
return $cat->baz($bar, ...);
99110
}
100111
}
101112

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp