Skip to content

Commit 4f8ff0e

Browse files
committed
Adding a note about the line lenghts
1 parent aae3a5f commit 4f8ff0e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

contributing/documentation/overview.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,14 @@ look and feel familiar, you should follow these rules:
7676

7777
* The code follows the :doc:`Symfony Coding Standards</contributing/code/standards>`
7878
as well as the `Twig Coding Standards`_;
79+
* Each line should break approximately after the first word that crosses the
80+
72nd character (so most lines end up being 72-78 lines);
7981
* When we fold one or more lines of code, we place ``...`` in a comment at the point
8082
of the fold. These comments are: ``// ...`` (php), ``# ...`` (yaml/bash), ``{# ... #}``
8183
(twig), ``<!-- ... -->`` (xml/html), ``; ...`` (ini), ``...`` (text);
8284
* When we fold a part of a line, e.g. a variable value, we put ``...`` (without comment)
8385
at the place of the fold;
84-
* Description of the foloed code: (optional)
86+
* Description of the folded code: (optional)
8587
If we fold several lines: the description of the fold can be placed after the ``...``
8688
If we fold only part of a line: the description can be placed before the line;
8789
* If useful, a ``codeblock`` should begin with a comment containing the filename

0 commit comments

Comments
 (0)