Skip to content

Commit 8978214

Browse files
committed
fixed paragraph about which versionadded directives will be removed
1 parent ec51f56 commit 8978214

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

contributing/documentation/format.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,32 +173,31 @@ New Features or Behavior Changes
173173

174174
If you're documenting a brand new feature or a change that's been made in
175175
Symfony, you should precede your description of the change with a
176-
``.. versionadded:: 2.X`` directive and a short description:
176+
``.. versionadded:: 3.x`` directive and a short description:
177177

178178
.. code-block:: rst
179179
180-
.. versionadded:: 2.7
180+
.. versionadded:: 3.4
181181
182-
The ``askHiddenResponse()`` method was introduced in Symfony 2.7.
183-
184-
You can also ask a question and hide the response. This is particularly [...]
182+
The special ``!`` template prefix was introduced in Symfony 3.4.
185183
186184
If you're documenting a behavior change, it may be helpful to *briefly* describe
187185
how the behavior has changed:
188186

189187
.. code-block:: rst
190188
191-
.. versionadded:: 2.7
189+
.. versionadded:: 3.4
192190
193-
The ``include()`` function is a new Twig feature that's available in
194-
Symfony 2.7. Prior, the ``{% include %}`` tag was used.
191+
Support for annotation routing without an external bundle was added in
192+
Symfony 3.4. Prior to version 3.4, you needed to install the
193+
SensioFrameworkExtraBundle.
195194
196-
Whenever a new minor version of Symfony is released (e.g. 2.4, 2.5, etc),
195+
Whenever a new major version of Symfony is released (e.g. 3.0, 4.0, etc),
197196
a new branch of the documentation is created from the ``master`` branch.
198197
At this point, all the ``versionadded`` tags for Symfony versions that have
199-
reached end-of-maintenance will be removed. For example, if Symfony 2.5 were
200-
released today, and 2.2 had recently reached its end-of-maintenance, the 2.2
201-
``versionadded`` tags would be removed from the new ``2.5`` branch.
198+
a lower major version will be removed. For example, if Symfony 4.0 were
199+
released today, 3.0 to 3.4 ``versionadded`` tags would be removed from the new
200+
``4.0`` branch.
202201

203202
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
204203
.. _Sphinx: http://sphinx-doc.org/

0 commit comments

Comments
 (0)