Skip to content

Update master for new documentation standards #2784

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.

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 29, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions book/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1702,8 +1702,8 @@ a route so that you can use it to generate the URL:

.. caution::

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

.. configuration-block::

Expand Down
5 changes: 3 additions & 2 deletions book/stable_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ everything not tagged explicitly is not part of the stable API.

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

As of Symfony 2.0, the following components have a public tagged API:
As of the latest stable release of Symfony, the following components have
a public tagged API:

* BrowserKit
* ClassLoader
Expand All @@ -31,7 +32,7 @@ As of Symfony 2.0, the following components have a public tagged API:
* DependencyInjection
* DomCrawler
* EventDispatcher
* Filesystem (as of Symfony 2.1)
* Filesystem
* Finder
* HttpFoundation
* HttpKernel
Expand Down
6 changes: 2 additions & 4 deletions components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,7 @@ thrown.

.. note::

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

.. _`Packagist`: https://packagist.org/packages/symfony/filesystem
2 changes: 1 addition & 1 deletion components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Stopwatch Component

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

Installation
------------
Expand Down
9 changes: 2 additions & 7 deletions cookbook/bundles/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ basic steps for installing a bundle are the same.
Add Composer Dependencies
-------------------------

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

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

In the case of the FOSUserBundle, the ``README`` file has a caution that version
1.2.0 must be used for Symfony 2.0 and 1.3+ for Symfony 2.1+. Packagist displays
example ``require`` statements for all existing versions of a package. The
current development version of FOSUserBundle is ``"friendsofsymfony/user-bundle": "2.0.*@dev"``.

Now you can add the bundle to your ``composer.json`` file and update the
dependencies. You can do this manually:

Expand Down
4 changes: 2 additions & 2 deletions cookbook/configuration/override_dir_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ may need to modify the paths inside these files::
require_once __DIR__.'/../Symfony/app/bootstrap.php.cache';
require_once __DIR__.'/../Symfony/app/AppKernel.php';

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

.. code-block:: json

Expand Down
4 changes: 2 additions & 2 deletions reference/constraints/Image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The Image constraint works exactly like the :doc:`File</reference/constraints/Fi
constraint, except that its `mimeTypes`_ and `mimeTypesMessage` options are
automatically setup to work for image files specifically.

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

See the :doc:`File</reference/constraints/File>` constraint for the bulk of
the documentation on this constraint.
Expand Down
3 changes: 0 additions & 3 deletions reference/forms/types/options/error_mapping.rst.inc
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
.. versionadded:: 2.1
The ``error_mapping`` option is new to Symfony 2.1.

error_mapping
~~~~~~~~~~~~~

Expand Down
3 changes: 0 additions & 3 deletions reference/forms/types/options/property_path.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,3 @@ If you wish the field to be ignored when reading or writing to the object
you can set the ``property_path`` option to ``false``, but using
``property_path`` for this purpose is deprecated, you should use the
``mapped`` option.

.. versionadded:: 2.1
Since 2.1, the ``mapped`` option has been added for this use-case.