Skip to content

Commit 1f78980

Browse files
committed
[#2720] Playing "catch-up" to get the master branch up to date with the new documentation standards
Specifically, I'm pretending as if 2.1 had reached its end-of-life today, and am applying all the needed changes to the master branch
1 parent ca1a38d commit 1f78980

File tree

9 files changed

+14
-26
lines changed

9 files changed

+14
-26
lines changed

book/security.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1702,8 +1702,8 @@ a route so that you can use it to generate the URL:
17021702

17031703
.. caution::
17041704

1705-
As of Symfony 2.1, you *must* have a route that corresponds to your logout
1706-
path. Without this route, logging out will not work.
1705+
You *must* have a route that corresponds to your logout path. Without
1706+
this route, logging out will not work.
17071707

17081708
.. configuration-block::
17091709

book/stable_api.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ everything not tagged explicitly is not part of the stable API.
2222

2323
Any third party bundle should also publish its own stable API.
2424

25-
As of Symfony 2.0, the following components have a public tagged API:
25+
As of the latest stable release of Symfony, the following components have
26+
a public tagged API:
2627

2728
* BrowserKit
2829
* ClassLoader
@@ -31,7 +32,7 @@ As of Symfony 2.0, the following components have a public tagged API:
3132
* DependencyInjection
3233
* DomCrawler
3334
* EventDispatcher
34-
* Filesystem (as of Symfony 2.1)
35+
* Filesystem
3536
* Finder
3637
* HttpFoundation
3738
* HttpKernel

components/filesystem.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,7 @@ thrown.
258258

259259
.. note::
260260

261-
Prior to version 2.1, ``mkdir`` returned a boolean and did not throw
262-
exceptions. As of 2.1, a
263-
:class:`Symfony\\Component\\Filesystem\\Exception\\IOException` is thrown
264-
if a directory creation fails.
261+
An :class:`Symfony\\Component\\Filesystem\\Exception\\IOException` is
262+
thrown if directory creation fails.
265263

266264
.. _`Packagist`: https://packagist.org/packages/symfony/filesystem

components/stopwatch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Stopwatch Component
99

1010
.. versionadded:: 2.2
1111
The Stopwatch Component is new to Symfony 2.2. Previously, the ``Stopwatch``
12-
class was located in the ``HttpKernel`` component (and was new in 2.1).
12+
class was located in the ``HttpKernel`` component.
1313

1414
Installation
1515
------------

cookbook/bundles/installation.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ basic steps for installing a bundle are the same.
1010
Add Composer Dependencies
1111
-------------------------
1212

13-
Starting from Symfony 2.1, dependencies are managed with Composer. It's
14-
a good idea to learn some basics of Composer in `their documentation`_.
13+
In Symfony, dependencies are managed with Composer. It's a good idea to learn
14+
some basics of Composer in `their documentation`_.
1515

1616
Before you can use composer to install a bundle, you should look for a
1717
`Packagist`_ package of that bundle. For example, if you search for the popular
@@ -33,11 +33,6 @@ file. If it isn't, you can use the version you want. If you choose an incompatib
3333
version, Composer will throw dependency errors when you try to install. If
3434
this happens, you can try a different version.
3535

36-
In the case of the FOSUserBundle, the ``README`` file has a caution that version
37-
1.2.0 must be used for Symfony 2.0 and 1.3+ for Symfony 2.1+. Packagist displays
38-
example ``require`` statements for all existing versions of a package. The
39-
current development version of FOSUserBundle is ``"friendsofsymfony/user-bundle": "2.0.*@dev"``.
40-
4136
Now you can add the bundle to your ``composer.json`` file and update the
4237
dependencies. You can do this manually:
4338

cookbook/configuration/override_dir_structure.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ may need to modify the paths inside these files::
9191
require_once __DIR__.'/../Symfony/app/bootstrap.php.cache';
9292
require_once __DIR__.'/../Symfony/app/AppKernel.php';
9393

94-
Since Symfony 2.1 (in which Composer is introduced), you also need to change
95-
the ``extra.symfony-web-dir`` option in the ``composer.json`` file:
94+
You also need to change the ``extra.symfony-web-dir`` option in the ``composer.json``
95+
file:
9696

9797
.. code-block:: json
9898

reference/constraints/Image.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ The Image constraint works exactly like the :doc:`File</reference/constraints/Fi
55
constraint, except that its `mimeTypes`_ and `mimeTypesMessage` options are
66
automatically setup to work for image files specifically.
77

8-
Additionally, as of Symfony 2.1, it has options so you can validate against
9-
the width and height of the image.
8+
Additionally it has options so you can validate against the width and height
9+
of the image.
1010

1111
See the :doc:`File</reference/constraints/File>` constraint for the bulk of
1212
the documentation on this constraint.

reference/forms/types/options/error_mapping.rst.inc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
.. versionadded:: 2.1
2-
The ``error_mapping`` option is new to Symfony 2.1.
3-
41
error_mapping
52
~~~~~~~~~~~~~
63

reference/forms/types/options/property_path.rst.inc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,3 @@ If you wish the field to be ignored when reading or writing to the object
1414
you can set the ``property_path`` option to ``false``, but using
1515
``property_path`` for this purpose is deprecated, you should use the
1616
``mapped`` option.
17-
18-
.. versionadded:: 2.1
19-
Since 2.1, the ``mapped`` option has been added for this use-case.

0 commit comments

Comments
 (0)