Skip to content

Commit 43d1fa7

Browse files
committed
Merge pull request #2138 from symfony/versionadded
Documenting how we should use the versionadded tag - see https://groups....
2 parents fbb6196 + 4317e2a commit 43d1fa7

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

contributing/documentation/overview.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,36 @@ An example submission could now look as follows:
110110
by going to the `Documentation Build Errors`_ page (it is updated each French
111111
night at 3AM when the server rebuilds the documentation).
112112

113+
Documenting new Features or Behavior Changes
114+
--------------------------------------------
115+
116+
If you're documenting a brand new feature or a change that's been made in
117+
Symfony2, you should precede your description of the change with a ``.. versionadded:: 2.X``
118+
tag and a short description:
119+
120+
.. code-block:: text
121+
122+
.. versionadded:: 2.2
123+
The ``askHiddenResponse`` method was added in Symfony 2.2.
124+
125+
You can also ask a question and hide the response. This is particularly...
126+
127+
If you're documenting a behavior change, it may be helpful to *briefly* describe
128+
how the behavior has changed.
129+
130+
.. code-block:: text
131+
132+
.. versionadded:: 2.2
133+
The ``include()`` function is a new Twig feature that's available in
134+
Symfony 2.2. Prior, the ``{% include %}`` tag was used.
135+
136+
Whenever a new version of minor of Symfony2 is released (e.g. 2.3, 2.4, etc),
137+
a new branch of the documentation is created from the ``master`` branch.
138+
At this point, all the ``versionadded`` tags for Symfony2 versions that have
139+
reached end-of-life will be removed. For example, if Symfony 2.5 were released
140+
today, and 2.2 had recently reached its end-of-life, the 2.2 ``versionadded``
141+
tags would be removed from the new 2.5 branch.
142+
113143
Standards
114144
---------
115145

0 commit comments

Comments
 (0)