Skip to content

Commit

Permalink
minor #3832 fix the wording in versionadded directives (for the 2.3 b…
Browse files Browse the repository at this point in the history
…ranch) (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

fix the wording in versionadded directives (for the 2.3 branch)

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

a2d39a1 fix the wording in versionadded directives
  • Loading branch information
weaverryan committed May 9, 2014
2 parents 09d6ca1 + a2d39a1 commit e58e39f
Show file tree
Hide file tree
Showing 41 changed files with 81 additions and 72 deletions.
10 changes: 5 additions & 5 deletions book/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,10 +232,10 @@ controller::
}

.. versionadded:: 2.3
The :method:`Symfony\\Component\\Form\\FormInterface::handleRequest` method was
added in Symfony 2.3. Previously, the ``$request`` was passed to the
``submit`` method - a strategy which is deprecated and will be removed
in Symfony 3.0. For details on that method, see :ref:`cookbook-form-submit-request`.
The :method:`Symfony\\Component\\Form\\FormInterface::handleRequest` method
was introduced in Symfony 2.3. Previously, the ``$request`` was passed
to the ``submit`` method - a strategy which is deprecated and will be
removed in Symfony 3.0. For details on that method, see :ref:`cookbook-form-submit-request`.

This controller follows a common pattern for handling forms, and has three
possible paths:
Expand Down Expand Up @@ -1845,7 +1845,7 @@ but here's a short example:
.. versionadded:: 2.1
The ``constraints`` option, which accepts a single constraint or an array
of constraints (before 2.1, the option was called ``validation_constraint``,
and only accepted a single constraint) is new to Symfony 2.1.
and only accepted a single constraint) was introduced in Symfony 2.1.
.. code-block:: php
Expand Down
6 changes: 3 additions & 3 deletions book/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ The route is simple:
return $collection;
.. versionadded:: 2.2
The ``path`` option is new in Symfony 2.2, ``pattern`` is used in older
versions.
The ``path`` option was introduced in Symfony 2.2, ``pattern`` is used
in older versions.

The path defined by the ``blog_show`` route acts like ``/blog/*`` where
the wildcard is given the name ``slug``. For the URL ``/blog/my-blog-post``,
Expand Down Expand Up @@ -704,7 +704,7 @@ be accomplished with the following route configuration:
return $collection;
.. versionadded:: 2.2
The ``methods`` option is added in Symfony 2.2. Use the ``_method``
The ``methods`` option was introduced in Symfony 2.2. Use the ``_method``
requirement in older versions.

Despite the fact that these two routes have identical paths (``/contact``),
Expand Down
3 changes: 2 additions & 1 deletion book/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1846,7 +1846,8 @@ Utilities
---------

.. versionadded:: 2.2
The ``StringUtils`` and ``SecureRandom`` classes were added in Symfony 2.2
The ``StringUtils`` and ``SecureRandom`` classes were introduced in Symfony
2.2

The Symfony Security component comes with a collection of nice utilities related
to security. These utilities are used by Symfony, but you should also use
Expand Down
5 changes: 3 additions & 2 deletions book/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,9 @@ Accessing internal Objects
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.3
The ``getInternalRequest()`` and ``getInternalResponse()`` method were
added in Symfony 2.3.
The :method:`Symfony\\Component\\BrowserKit\\Client::getInternalRequest`
and :method:`Symfony\\Component\\BrowserKit\\Client::getInternalResponse`
methods were introduced in Symfony 2.3.

If you use the client to test your application, you might want to access the
client's internal objects::
Expand Down
2 changes: 1 addition & 1 deletion book/translation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ texts* and complex expressions:
template (in order to avoid side effects).

.. versionadded:: 2.1
The ``trans_default_domain`` tag is new in Symfony 2.1
The ``trans_default_domain`` tag was introduced in Symfony 2.1.

PHP Templates
~~~~~~~~~~~~~
Expand Down
7 changes: 4 additions & 3 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Numeric Node Constraints
~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.2
The numeric (float and integer) nodes are new in 2.2
The numeric (float and integer) nodes were introduced in Symfony 2.2.

Numeric nodes (float and integer) provide two extra constraints -
:method:`Symfony\\Component\\Config\\Definition\\Builder::min` and
Expand All @@ -137,7 +137,7 @@ Enum Nodes
~~~~~~~~~~

.. versionadded:: 2.1
The enum node is new in Symfony 2.1
The enum node was introduced in Symfony 2.1.

Enum nodes provide a constraint to match the given input against a set of
values::
Expand Down Expand Up @@ -291,7 +291,8 @@ Optional Sections
-----------------

.. versionadded:: 2.2
The ``canBeEnabled`` and ``canBeDisabled`` methods are new in Symfony 2.2
The ``canBeEnabled`` and ``canBeDisabled`` methods were introduced in
Symfony 2.2.

If you have entire sections which are optional and can be enabled/disabled,
you can take advantage of the shortcut
Expand Down
2 changes: 1 addition & 1 deletion components/console/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Using Events
============

.. versionadded:: 2.3
Console events were added in Symfony 2.3.
Console events were introduced in Symfony 2.3.

The Application class of the Console component allows you to optionally hook
into the lifecycle of a console application via events. Instead of reinventing
Expand Down
4 changes: 2 additions & 2 deletions components/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ The Debug Component
The Debug component provides tools to ease debugging PHP code.

.. versionadded:: 2.3
The Debug component is new to Symfony 2.3. Previously, the classes were
located in the HttpKernel component.
The Debug component was introduced in Symfony 2.3. Previously, the classes
were located in the HttpKernel component.

Installation
------------
Expand Down
3 changes: 2 additions & 1 deletion components/dependency_injection/compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,8 @@ Prepending Configuration Passed to the Extension
------------------------------------------------

.. versionadded:: 2.2
The ability to prepend the configuration of a bundle is new in Symfony 2.2.
The ability to prepend the configuration of a bundle was introduced in
Symfony 2.2.

An Extension can prepend the configuration of any Bundle before the ``load()``
method is called by implementing :class:`Symfony\\Component\\DependencyInjection\\Extension\\PrependExtensionInterface`::
Expand Down
2 changes: 1 addition & 1 deletion components/dependency_injection/lazy_services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lazy Services
=============

.. versionadded:: 2.3
Lazy services were added in Symfony 2.3.
Lazy services were introduced in Symfony 2.3.

Why lazy Services?
------------------
Expand Down
6 changes: 3 additions & 3 deletions components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The Filesystem Component
The Filesystem component provides basic utilities for the filesystem.

.. versionadded:: 2.1
The Filesystem component is new to Symfony 2.1. Previously, the ``Filesystem``
class was located in the HttpKernel component.
The Filesystem component was introduced in Symfony 2.1. Previously, the
``Filesystem`` class was located in the HttpKernel component.

Installation
------------
Expand Down Expand Up @@ -237,7 +237,7 @@ dumpFile
~~~~~~~~

.. versionadded:: 2.3
``dumpFile`` is new in Symfony 2.3.
The ``dumpFile()`` was introduced in Symfony 2.3.

:method:`Symfony\\Component\\Filesystem\\Filesystem::dumpFile` allows you to
dump contents to a file. It does this in an atomic manner: it writes a temporary
Expand Down
2 changes: 1 addition & 1 deletion components/finder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Path
~~~~

.. versionadded:: 2.2
The ``path()`` and ``notPath()`` methods were added in version 2.2.
The ``path()`` and ``notPath()`` methods were introduced in Symfony 2.2.

Restrict files and directories by path with the
:method:`Symfony\\Component\\Finder\\Finder::path` method::
Expand Down
3 changes: 2 additions & 1 deletion components/http_foundation/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,8 @@ by using the following methods:
returns the list of accepted charsets ordered by descending quality.

.. versionadded:: 2.2
The :class:`Symfony\\Component\\HttpFoundation\\AcceptHeader` class is new in Symfony 2.2.
The :class:`Symfony\\Component\\HttpFoundation\\AcceptHeader` class was
introduced in Symfony 2.2.

If you need to get full access to parsed data from ``Accept``, ``Accept-Language``,
``Accept-Charset`` or ``Accept-Encoding``, you can use
Expand Down
3 changes: 2 additions & 1 deletion components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ The component takes care of the subtle differences between the different platfor
when executing the command.

.. versionadded:: 2.2
The ``getIncrementalOutput()`` and ``getIncrementalErrorOutput()`` methods were added in Symfony 2.2.
The ``getIncrementalOutput()`` and ``getIncrementalErrorOutput()`` methods
were introduced in Symfony 2.2.

The ``getOutput()`` method always return the whole content of the standard
output of the command and ``getErrorOutput()`` the content of the error
Expand Down
8 changes: 4 additions & 4 deletions components/property_access/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The PropertyAccess Component
object or array using a simple string notation.

.. versionadded:: 2.2
The PropertyAccess component is new to Symfony 2.2. Previously, the
``PropertyPath`` class was located in the Form component.
The PropertyAccess component was introduced in Symfony 2.2. Previously,
the ``PropertyPath`` class was located in the Form component.

Installation
------------
Expand All @@ -34,8 +34,8 @@ default configuration::
$accessor = PropertyAccess::createPropertyAccessor();

.. versionadded:: 2.3
Before Symfony 2.3, the :method:`Symfony\\Component\\PropertyAccess\\PropertyAccess::createPropertyAccessor`
was called ``getPropertyAccessor()``.
The :method:`Symfony\\Component\\PropertyAccess\\PropertyAccess::createPropertyAccessor`
method was introduced in Symfony 2.3. Previously, it was called ``getPropertyAccessor()``.

Reading from Arrays
-------------------
Expand Down
7 changes: 4 additions & 3 deletions components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ The Stopwatch Component
Stopwatch component provides a way to profile code.

.. 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).
The Stopwatch component was introduced in Symfony 2.2. Previously, the
``Stopwatch`` class was located in the HttpKernel component (and was introduced
in Symfony 2.1).

Installation
------------
Expand All @@ -36,7 +37,7 @@ microtime by yourself. Instead, use the simple
$event = $stopwatch->stop('eventName');

The :class:`Symfony\\Component\\Stopwatch\\StopwatchEvent` object can be retrieved
from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`,
from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`,
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop` and
:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` methods.

Expand Down
4 changes: 2 additions & 2 deletions components/translation/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ Loader too. The default loaders are:

.. versionadded:: 2.1
The ``IcuDatFileLoader``, ``IcuResFileLoader``, ``IniFileLoader``,
``MofileLoader``, ``PoFileLoader`` and ``QtFileLoader`` were added in
Symfony 2.1
``MofileLoader``, ``PoFileLoader`` and ``QtFileLoader`` were introduced
in Symfony 2.1.

All file loaders require the :doc:`Config component </components/config/index>`.

Expand Down
2 changes: 1 addition & 1 deletion cookbook/console/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ To get your console application to automatically log uncaught exceptions for
all of your commands, you can use :doc:`console events</components/console/events>`.

.. versionadded:: 2.3
Console events were added in Symfony 2.3.
Console events were introduced in Symfony 2.3.

First configure a listener for console exception events in the service container:

Expand Down
10 changes: 5 additions & 5 deletions cookbook/console/sending_emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Configuring the Request Context globally
----------------------------------------

.. versionadded: 2.2
The ``base_url`` parameter is available since Symfony 2.2
The ``base_url`` parameter was introduced in Symfony 2.2.
To configure the Request Context - which is used by the URL Generator - you can
redefine the parameters it uses as default values to change the default host
Expand Down Expand Up @@ -98,14 +98,14 @@ the queue yourself. Use the following code to send emails inside your
console command::

$message = new \Swift_Message();

// ... prepare the message

$container = $this->getContainer();
$mailer = $container->get('mailer');

$mailer->send($message);

// now manually flush the queue
$spool = $mailer->getTransport()->getSpool();
$transport = $container->get('swiftmailer.transport.real');
Expand Down
4 changes: 2 additions & 2 deletions cookbook/form/dynamic_form_modification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,8 +518,8 @@ On a form, we can usually listen to the following events:
* ``POST_SUBMIT``

.. versionadded:: 2.3
The events ``PRE_SUBMIT``, ``SUBMIT`` and ``POST_SUBMIT`` were added in
Symfony 2.3. Before, they were named ``PRE_BIND``, ``BIND`` and ``POST_BIND``.
The events ``PRE_SUBMIT``, ``SUBMIT`` and ``POST_SUBMIT`` were introduced
in Symfony 2.3. Before, they were named ``PRE_BIND``, ``BIND`` and ``POST_BIND``.

.. versionadded:: 2.2.6
The behavior of the ``POST_SUBMIT`` event changed slightly in 2.2.6, which the
Expand Down
3 changes: 2 additions & 1 deletion cookbook/form/inherit_data_option.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ How to Reduce Code Duplication with "inherit_data"
==================================================

.. versionadded:: 2.3
This ``inherit_data`` option was known as ``virtual`` before Symfony 2.3.
This ``inherit_data`` option was introduced in Symfony 2.3. Before, it
was known as ``virtual``.

The ``inherit_data`` form field option can be very useful when you have some
duplicated fields in different entities. For example, imagine you have two
Expand Down
2 changes: 1 addition & 1 deletion cookbook/service_container/scopes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Using a synchronized Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.3
Synchronized services are new in Symfony 2.3.
Synchronized services were introduced in Symfony 2.3.

Injecting the container or setting your service to a narrower scope have
drawbacks. For synchronized services (like the ``request``), using setter
Expand Down
2 changes: 1 addition & 1 deletion cookbook/templating/render_without_controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Caching the static Template

.. versionadded:: 2.2
The ability to cache templates rendered via ``FrameworkBundle:Template:template``
is new in Symfony 2.2.
was introduced in Symfony 2.2.

Since templates that are rendered in this way are typically static, it might
make sense to cache them. Fortunately, this is easy! By configuring a few
Expand Down
10 changes: 5 additions & 5 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ http_method_override
~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 2.3
The ``http_method_override`` option is new in Symfony 2.3.
The ``http_method_override`` option was introduced in Symfony 2.3.

**type**: ``Boolean`` **default**: ``true``

Expand Down Expand Up @@ -422,10 +422,10 @@ enabled
The profiler can be disabled by setting this key to ``false``.

.. versionadded:: 2.3

The ``collect`` option is new in Symfony 2.3. Previously, when ``profiler.enabled``
was false, the profiler *was* actually enabled, but the collectors were
disabled. Now the profiler and collectors can be controller independently.
The ``collect`` option was introduced in Symfony 2.3. Previously, when
``profiler.enabled`` was ``false``, the profiler *was* actually enabled,
but the collectors were disabled. Now, the profiler and the collectors
can be controlled independently.

collect
.......
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/CardScheme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ CardScheme
==========

.. versionadded:: 2.2
The CardScheme validation is new in Symfony 2.2.
The ``CardScheme`` constraint was introduced in Symfony 2.2.

This constraint ensures that a credit card number is valid for a given credit card
company. It can be used to validate the number before trying to initiate a payment
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/Currency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Currency
========

.. versionadded:: 2.3
This constraint is new in version 2.3.
The ``Currency`` constraint was introduced in Symfony 2.3.

Validates that a value is a valid `3-letter ISO 4217`_ currency name.

Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/EqualTo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ EqualTo
=======

.. versionadded:: 2.3
This constraint is new in version 2.3.
The ``EqualTo`` constraint was introduced in Symfony 2.3.

Validates that a value is equal to another value, defined in the options. To
force that a value is *not* equal, see :doc:`/reference/constraints/NotEqualTo`.
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/GreaterThan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ GreaterThan
===========

.. versionadded:: 2.3
This constraint is new in version 2.3.
The ``GreaterThan`` constraint was introduced in Symfony 2.3.

Validates that a value is greater than another value, defined in the options. To
force that a value is greater than or equal to another value, see
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/GreaterThanOrEqual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ GreaterThanOrEqual
==================

.. versionadded:: 2.3
This constraint is new in version 2.3.
The ``GreaterThanOrEqual`` constraint was introduced in Symfony 2.3.

Validates that a value is greater than or equal to another value, defined in
the options. To force that a value is greater than another value, see
Expand Down
2 changes: 1 addition & 1 deletion reference/constraints/IdenticalTo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ IdenticalTo
===========

.. versionadded:: 2.3
This constraint is new in version 2.3.
The ``IdenticalTo`` constraint was introduced in Symfony 2.3.

Validates that a value is identical to another value, defined in the options.
To force that a value is *not* identical, see
Expand Down
Loading

0 comments on commit e58e39f

Please sign in to comment.