|
16 | 16 | shorthand);
|
17 | 17 | * Inline hyperlinks are **not** used. Seperate the link and their target
|
18 | 18 | 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; |
20 | 20 | * You should use a form of *you* instead of *we*.
|
21 | 21 |
|
22 | 22 | Example
|
@@ -61,10 +61,11 @@ Code Examples
|
61 | 61 | * Description of the folded code: (optional)
|
62 | 62 | If you fold several lines: the description of the fold can be placed after the ``...``
|
63 | 63 | 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; |
68 | 69 | * If useful, a ``codeblock`` should begin with a comment containing the filename
|
69 | 70 | of the file in the code block. Don't place a blank line after this comment,
|
70 | 71 | unless the next line is also a comment;
|
|
0 commit comments