Skip to content

Use current major version for deprecated/versionadded examples #11681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2019
Merged

Use current major version for deprecated/versionadded examples #11681

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions contributing/documentation/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,40 +175,39 @@ If you are documenting a brand new feature, a change or a deprecation that's
been made in Symfony, you should precede your description of the change with
the corresponding directive and a short description:

For a new feature or a behavior change use the ``.. versionadded:: 3.x``
For a new feature or a behavior change use the ``.. versionadded:: 4.x``
directive:

.. code-block:: rst

.. versionadded:: 3.4
.. versionadded:: 4.2

The special ``!`` template prefix was introduced in Symfony 3.4.
Named autowiring aliases have been introduced in Symfony 4.2.

If you are documenting a behavior change, it may be helpful to *briefly*
describe how the behavior has changed:

.. code-block:: rst

.. versionadded:: 3.4
.. versionadded:: 4.2

Support for annotation routing without an external bundle was introduced
in Symfony 3.4. Prior, you needed to install the SensioFrameworkExtraBundle.
Support for ICU MessageFormat was introduced in Symfony 4.2. Prior to this,
pluralization was managed by the ``transChoice`` method.

For a deprecation use the ``.. deprecated:: 3.X`` directive:
For a deprecation use the ``.. deprecated:: 4.X`` directive:

.. code-block:: rst

.. deprecated:: 3.3
.. deprecated:: 4.2

This technique is discouraged and the ``addClassesToCompile()`` method was
deprecated in Symfony 3.3 because modern PHP versions make it unnecessary.
Not passing the root node name to ``TreeBuilder`` was deprecated in Symfony 4.2.

Whenever a new major version of Symfony is released (e.g. 3.0, 4.0, etc),
Whenever a new major version of Symfony is released (e.g. 5.0, 6.0, etc),
a new branch of the documentation is created from the ``master`` branch.
At this point, all the ``versionadded`` and ``deprecated`` tags for Symfony
versions that have a lower major version will be removed. For example, if
Symfony 4.0 were released today, 3.0 to 3.4 ``versionadded`` and ``deprecated``
tags would be removed from the new ``4.0`` branch.
Symfony 5.0 were released today, 4.0 to 4.4 ``versionadded`` and ``deprecated``
tags would be removed from the new ``5.0`` branch.

.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
Expand Down