Skip to content

Commit 4317e2a

Browse files
committed
Documenting how we should use the versionadded tag - see https://groups.google.com/forum/#!msg/symfony-devs/-6HAQgAB2LY/uBSx8uYJQdQJ
1 parent 1695853 commit 4317e2a

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
@@ -78,6 +78,36 @@ GitHub covers the topic of `pull requests`_ in detail.
7878
by going to the `Documentation Build Errors`_ page (it is updated each French
7979
night at 3AM when the server rebuilds the documentation).
8080

81+
Documenting new Features or Behavior Changes
82+
--------------------------------------------
83+
84+
If you're documenting a brand new feature or a change that's been made in
85+
Symfony2, you should precede your description of the change with a ``.. versionadded:: 2.X``
86+
tag and a short description:
87+
88+
.. code-block:: text
89+
90+
.. versionadded:: 2.2
91+
The ``askHiddenResponse`` method was added in Symfony 2.2.
92+
93+
You can also ask a question and hide the response. This is particularly...
94+
95+
If you're documenting a behavior change, it may be helpful to *briefly* describe
96+
how the behavior has changed.
97+
98+
.. code-block:: text
99+
100+
.. versionadded:: 2.2
101+
The ``include()`` function is a new Twig feature that's available in
102+
Symfony 2.2. Prior, the ``{% include %}`` tag was used.
103+
104+
Whenever a new version of minor of Symfony2 is released (e.g. 2.3, 2.4, etc),
105+
a new branch of the documentation is created from the ``master`` branch.
106+
At this point, all the ``versionadded`` tags for Symfony2 versions that have
107+
reached end-of-life will be removed. For example, if Symfony 2.5 were released
108+
today, and 2.2 had recently reached its end-of-life, the 2.2 ``versionadded``
109+
tags would be removed from the new 2.5 branch.
110+
81111
Standards
82112
---------
83113

0 commit comments

Comments
 (0)