Skip to content

Commit 88065b0

Browse files
committed
[symfony#2994] Small tweaks to new standards
1 parent d09b00c commit 88065b0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

contributing/documentation/standards.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +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 at the same line as the open-string;
19+
* Inline markup should be closed on the same line as the open-string;
2020
* You should use a form of *you* instead of *we*.
2121

2222
Example
@@ -61,10 +61,11 @@ Code Examples
6161
* Description of the folded code: (optional)
6262
If you fold several lines: the description of the fold can be placed after the ``...``
6363
If you fold only part of a line: the description can be placed before the line;
64-
* If usefull, a PHP file should start with the namespace declaration;
65-
* When using use statements, only the first code block of an article shows the
66-
full statement block. In further examples, this block is folded with a
67-
``// ...`` comment and only new use statements are displayed;
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;
6869
* If useful, a ``codeblock`` should begin with a comment containing the filename
6970
of the file in the code block. Don't place a blank line after this comment,
7071
unless the next line is also a comment;

0 commit comments

Comments
 (0)