Skip to content

Commit 4eac3ed

Browse files
committed
Fixed to long lines
1 parent 0d7f858 commit 4eac3ed

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

contributing/documentation/overview.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,21 @@ GitHub covers the topic of `pull requests`_ in detail.
7171
Standards
7272
---------
7373

74-
In order to help the reader as much as possible and to create code examples that looks and feels familiar, you should follow these rules:
75-
76-
* The code follows the Coding Standards, the :doc:`Symfony Coding Standards</contributing/code/standards>` as well as the `Twig Coding Standards`_;
77-
* When we fold one or more lines of code, we place `...` in a comment at the point of the fold. These comments are: `// ...` (php), `# ...` (yaml/bash), `{# ... #}` (twig), `<!-- ... -->` (xml/html), `; ...` (ini), `...` (text);
78-
* When we fold a part of a line, e.g. a variable value, we put `...` (without comment) at the place of the fold;
74+
In order to help the reader as much as possible and to create code examples that
75+
looks and feels familiar, you should follow these rules:
76+
77+
* The code follows the Coding Standards, the :doc:`Symfony Coding Standards</contributing/code/standards>`
78+
as well as the `Twig Coding Standards`_;
79+
* When we fold one or more lines of code, we place `...` in a comment at the point
80+
of the fold. These comments are: `// ...` (php), `# ...` (yaml/bash), `{# ... #}`
81+
(twig), `<!-- ... -->` (xml/html), `; ...` (ini), `...` (text);
82+
* When we fold a part of a line, e.g. a variable value, we put `...` (without comment)
83+
at the place of the fold;
7984
* Description about the fold: (optional)
8085
If we fold some lines: The description can be placed after the `...`
8186
If we fold a part of a line: The description can be placed before the line;
82-
* If usefull, a codeblock begins with a comment with the filename. After this comment should not be a blank line, except if the next line is a comment too;
87+
* If usefull, a codeblock begins with a comment with the filename. After this comment
88+
should not be a blank line, except if the next line is a comment too;
8389
* You should put a `$` in front of every bash line;
8490
* We prefer the `::` shorthand over `.. code-block:: php` to begin a PHP code block.
8591

@@ -97,8 +103,10 @@ An example::
97103
}
98104

99105
.. note::
100-
* In Yaml you should to put a space after `{` and before `}` (e.g. `{ _controller: ... }`), but this should not be done in Twig (e.g. `{'hello' : 'value'}`).
101-
* An array item is a part of a line, not a complete line. So you should not use `// ...` but `...,` (the comma because of the Coding Standards)::
106+
* In Yaml you should to put a space after `{` and before `}` (e.g. `{ _controller: ... }`),
107+
but this should not be done in Twig (e.g. `{'hello' : 'value'}`).
108+
* An array item is a part of a line, not a complete line. So you should not use `// ...`
109+
but `...,` (the comma because of the Coding Standards)::
102110

103111
array(
104112
'some value',

0 commit comments

Comments
 (0)