Skip to content

added blank line after .. versionadded:: directive #10823

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
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
1 change: 1 addition & 0 deletions best_practices/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ through environment variables:
password: "%env(DB_PASSWORD)%"

.. versionadded:: 3.2

Support for runtime environment variables via the ``%env(...)%`` syntax
was added in Symfony 3.2. Prior to version 3.2, you needed to use the
:doc:`special SYMFONY__ variables </configuration/external_parameters>`.
Expand Down
3 changes: 3 additions & 0 deletions bundles/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ Adding Classes to Compile
-------------------------

.. versionadded:: 3.3

This technique is discouraged and the ``addClassesToCompile()`` method was
deprecated in Symfony 3.3 because modern PHP versions make it unnecessary.

Expand All @@ -138,6 +139,7 @@ the contents of the PHP classes that are used in every request. This reduces the
I/O operations and increases the application performance.

.. versionadded:: 3.2

The ``addAnnotatedClassesToCompile()`` method was added in Symfony 3.2.

Your bundles can also add their own classes into this file thanks to the
Expand Down Expand Up @@ -174,6 +176,7 @@ class names::
included in the list of classes to compile.

.. versionadded:: 3.2

The option to add classes to compile using patterns was introduced in Symfony 3.2.

The classes to compile can also be added using file path patterns::
Expand Down
1 change: 1 addition & 0 deletions components/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The Cache Component
from/to `Doctrine Cache`_.

.. versionadded:: 3.3

The PSR-16 "Simple Cache" implementation was introduced in Symfony 3.3.

Installation
Expand Down
1 change: 1 addition & 0 deletions components/cache/adapters/memcached_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ helper method allows creating and configuring a `Memcached`_ class instance usin
));

.. versionadded:: 3.4

The feature to pass configuration options in the memcached DSN was
introduced in Symfony 3.4.

Expand Down
1 change: 1 addition & 0 deletions components/cache/cache_invalidation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Using Cache Tags
----------------

.. versionadded:: 3.2

Tags-based invalidation was introduced in Symfony 3.2.

To benefit from tags-based invalidation, you need to attach the proper tags to
Expand Down
1 change: 1 addition & 0 deletions components/cache/cache_pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ when all items are successfully deleted)::
$ php bin/console cache:pool:clear cache.validation cache.app

.. versionadded:: 3.4

Starting from Symfony 3.4, the ``cache:clear`` command no longer clears
the cache pools, so you must use the ``cache:pool:clear`` command to
delete them.
Expand Down
2 changes: 2 additions & 0 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ Or you may define a prototype for each node inside an array node::
;

.. versionadded:: 3.3

The ``arrayPrototype()`` method (and the related ``booleanPrototype()``
``integerPrototype()``, ``floatPrototype()``, ``scalarPrototype()`` and
``enumPrototype()``) was introduced in Symfony 3.3. In previous versions,
Expand All @@ -199,6 +200,7 @@ above, it is possible to have multiple connection arrays (containing a ``driver`
``host``, etc.).

.. versionadded:: 3.3

The ``castToArray()`` helper was added in Symfony 3.3.

Sometimes, to improve the user experience of your application or bundle, you may
Expand Down
1 change: 1 addition & 0 deletions components/console/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ The ``ConsoleEvents::EXCEPTION`` Event
--------------------------------------

.. versionadded:: 3.3

The ``ConsoleEvents::EXCEPTION`` event was deprecated in Symfony 3.3. Use
the ``ConsoleEvents::ERROR`` event instead.

Expand Down
2 changes: 2 additions & 0 deletions components/console/helpers/questionhelper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ convenient for passwords::
}

.. versionadded:: 3.3

The ``QuestionHelper::disableStty()`` method was introduced in Symfony 3.3.

Normalizing the Answer
Expand Down Expand Up @@ -369,6 +370,7 @@ from the command line, you need to set the inputs that the command expects::
}

.. versionadded:: 3.2

The ``CommandTester::setInputs()`` method was introduced in Symfony 3.2.

By calling :method:`Symfony\\Component\\Console\\Tester\\CommandTester::setInputs`,
Expand Down
1 change: 1 addition & 0 deletions components/console/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Errors
------

.. versionadded:: 3.2

The ``hasErrored()`` method was introduced in Symfony 3.2.

The Console logger includes a ``hasErrored()`` method which returns ``true`` as
Expand Down
1 change: 1 addition & 0 deletions components/console/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ command that match), then no command will be run and some suggestions of
the possible commands to choose from will be output.

.. versionadded:: 3.4

Case-insensitivity of command shortcuts was introduced in Symfony 3.4. In
previous Symfony versions, shortcuts had to match the case of the original
command name (e.g. ``d:g`` was not the same shortcut as ``D:G``).
1 change: 1 addition & 0 deletions components/dependency_injection/compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,7 @@ been run, use::
);

.. versionadded:: 3.2

The option to prioritize compiler passes was added in Symfony 3.2.

You can also control the order in which compiler passes are run for each
Expand Down
3 changes: 3 additions & 0 deletions components/dom_crawler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ The crawler supports multiple ways of adding the content::
``ISO-8859-1`` in case no charset can be guessed.

.. versionadded:: 3.4

The charset guessing mechanism of the ``addContent()`` method was
introduced in Symfony 3.4. In previous Symfony versions, the ``ISO-8859-1``
charset was always used.
Expand Down Expand Up @@ -300,6 +301,7 @@ Expression Evaluation
~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 3.2

The :method:`Symfony\\Component\\DomCrawler\\Crawler::evaluate` method was
introduced in Symfony 3.2.

Expand Down Expand Up @@ -443,6 +445,7 @@ is GET, then it mimics the browser's behavior and returns the ``action``
attribute followed by a query string of all of the form's values.

.. versionadded:: 3.3

Starting from Symfony 3.3, the optional ``formaction`` and ``formmethod``
button attributes are supported. The ``getUri()`` and ``getMethod()``
methods take into account those attributes to always return the right action
Expand Down
1 change: 1 addition & 0 deletions components/dotenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The Dotenv Component
stored in them accessible via ``getenv()``, ``$_ENV`` or ``$_SERVER``.

.. versionadded:: 3.3

The Dotenv component was introduced in Symfony 3.3.

Installation
Expand Down
1 change: 1 addition & 0 deletions components/event_dispatcher/container_aware_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The Container Aware Event Dispatcher
====================================

.. versionadded:: 3.3

The ``ContainerAwareEventDispatcher`` class has been deprecated in Symfony 3.3
and it will be removed in Symfony 4.0. Use ``EventDispatcher`` with
closure-proxy injection instead.
Expand Down
1 change: 1 addition & 0 deletions components/expression_language/caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ ones and injecting this using the constructor::
$expressionLanguage = new ExpressionLanguage($cache);

.. versionadded:: 3.2

PSR-6 caching support was introduced in Symfony 3.2. Prior to version 3.2,
a
:class:`Symfony\\Component\\ExpressionLanguage\\ParserCache\\ParserCacheInterface`
Expand Down
1 change: 1 addition & 0 deletions components/expression_language/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ register::
ExpressionFunction::fromPhp('My\strtoupper', 'my_strtoupper');

.. versionadded:: 3.3

The ``ExpressionFunction::fromPhp()`` method was introduced in Symfony 3.3.

You can register providers using
Expand Down
2 changes: 2 additions & 0 deletions components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ readlink
~~~~~~~~

.. versionadded:: 3.2

The :method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` method was introduced in Symfony 3.2.

:method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` read links targets.
Expand Down Expand Up @@ -299,6 +300,7 @@ appendToFile
~~~~~~~~~~~~

.. versionadded:: 3.3

The :method:`Symfony\\Component\\Filesystem\\Filesystem::appendToFile`
method was introduced in Symfony 3.3.

Expand Down
1 change: 1 addition & 0 deletions components/filesystem/lock_handler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ LockHandler
===========

.. versionadded:: 3.4

The ``LockHandler`` class was deprecated in Symfony 3.4 and it will be
removed in Symfony 4.0. Use :ref:`SemaphoreStore <lock-store-semaphore>`
or :ref:`FlockStore <lock-store-flock>` from the Lock component instead.
Expand Down
1 change: 1 addition & 0 deletions components/finder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ There are lots of ways to filter and sort your results. You can also use the
there's any file or directory matching the search criteria.

.. versionadded:: 3.4

The ``hasResults()`` method was introduced in Symfony 3.4.

Location
Expand Down
1 change: 1 addition & 0 deletions components/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ to bootstrap or access Twig and add the :class:`Symfony\\Bridge\\Twig\\Extension
->getFormFactory();

.. versionadded:: 1.30

The ``Twig\\RuntimeLoader\\FactoryRuntimeLoader`` was introduced in Twig 1.30.

The exact details of your `Twig Configuration`_ will vary, but the goal is
Expand Down
3 changes: 3 additions & 0 deletions components/http_foundation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,7 @@ Note you can create a
value using :method:`Symfony\\Component\\HttpFoundation\\Cookie::fromString`.

.. versionadded:: 3.3

The ``Cookie::fromString()`` method was introduced in Symfony 3.3.

Managing the HTTP Cache
Expand Down Expand Up @@ -539,6 +540,7 @@ It is possible to delete the file after the request is sent with the
Please note that this will not work when the ``X-Sendfile`` header is set.

.. versionadded:: 3.3

The ``Stream`` class was introduced in Symfony 3.3.

If the size of the served file is unknown (e.g. because it's being generated on the fly,
Expand Down Expand Up @@ -593,6 +595,7 @@ class, which can make this even easier::
$response = JsonResponse::fromJsonString('{ "data": 123 }');

.. versionadded:: 3.2

The :method:`Symfony\\Component\\HttpFoundation\\JsonResponse::fromJsonString`
method was added in Symfony 3.2.

Expand Down
1 change: 1 addition & 0 deletions components/lock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The Lock Component
exclusive access to a shared resource.

.. versionadded:: 3.4

The Lock component was introduced in Symfony 3.4.

Installation
Expand Down
1 change: 1 addition & 0 deletions components/options_resolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,7 @@ using ``instanceof``). Additionally, you can validate all items in an array
recursively by suffixing the type with ``[]``.

.. versionadded:: 3.4

Validating types of array items recursively was introduced in Symfony 3.4.
Prior to Symfony 3.4, only scalar values could be validated.

Expand Down
1 change: 1 addition & 0 deletions components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,7 @@ Modified PHPUnit script
-----------------------

.. versionadded:: 3.2

This modified PHPUnit script was introduced in the 3.2 version of
this component.

Expand Down
3 changes: 3 additions & 0 deletions components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ for new output before going to the next iteration::
}

.. versionadded:: 3.2

The ``getIterator()`` method was introduced in Symfony 3.2.

The ``mustRun()`` method is identical to ``run()``, except that it will throw
Expand All @@ -103,6 +104,7 @@ with a non-zero code)::
.. tip::

.. versionadded:: 3.3

The ability to define commands as arrays of arguments was introduced in
Symfony 3.3.

Expand Down Expand Up @@ -418,6 +420,7 @@ Use :method:`Symfony\\Component\\Process\\Process::disableOutput` and
methods to handle process output in a streaming fashion.

.. versionadded:: 3.1

The ability to pass a callback to these methods when output is disabled
was added in Symfony 3.1.

Expand Down
1 change: 1 addition & 0 deletions components/property_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@ and plural property names::
$propertyInfo->isWritable(SomeClass::class, 'feet'); // returns true

.. versionadded:: 3.2

The support of adder/remover methods was introduced in Symfony 3.2.

.. tip::
Expand Down
1 change: 1 addition & 0 deletions components/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ Unicode Routing Support
~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 3.2

UTF-8 support for route paths and requirements was introduced in
Symfony 3.2.

Expand Down
1 change: 1 addition & 0 deletions components/security/firewall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Firewall Config
~~~~~~~~~~~~~~~

.. versionadded:: 3.2

The ``FirewallConfig`` class was introduced in Symfony 3.2.

The information about a given firewall, such as its name, provider, context,
Expand Down
5 changes: 5 additions & 0 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ needs three parameters:
#. The encoder used to convert that information into an array

.. versionadded:: 3.3

Support for the ``allow_extra_attributes`` key in the context was introduced
in Symfony 3.3.

Expand Down Expand Up @@ -601,6 +602,7 @@ There are several types of normalizers available:
Objects are normalized to a map of property names to property values.

.. versionadded:: 3.4

The ability to handle parent classes for ``PropertyNormalizer`` was
introduced in Symfony 3.4.

Expand All @@ -623,6 +625,7 @@ There are several types of normalizers available:
By default it uses the RFC3339_ format.

.. versionadded:: 3.2

Support for specifying datetime format during denormalization was
introduced in the ``DateTimeNormalizer`` in Symfony 3.2.

Expand All @@ -635,6 +638,7 @@ There are several types of normalizers available:
By default it uses the ``P%yY%mM%dDT%hH%iM%sS`` format.

.. versionadded:: 3.4

The ``DateIntervalNormalizer`` normalizer was added in Symfony 3.4.

.. _component-serializer-encoders:
Expand All @@ -661,6 +665,7 @@ All these encoders are enabled by default when using the Symfony Standard Editio
with the serializer enabled.

.. versionadded:: 3.2

The ``YamlEncoder`` and ``CsvEncoder`` encoders were introduced in Symfony 3.2

.. _component-serializer-handling-circular-references:
Expand Down
1 change: 1 addition & 0 deletions components/stopwatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ while it is still running.
$stopwatch = new Stopwatch(true);

.. versionadded:: 3.4

Full precision support was introduced in Symfony 3.4.

You can also provide a category name to an event::
Expand Down
1 change: 1 addition & 0 deletions components/translation/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ Adding Notes to Translation Contents
------------------------------------

.. versionadded:: 3.4

The feature to load and dump translation notes was introduced in Symfony 3.4.

Sometimes translators need additional context to better decide how to translate
Expand Down
1 change: 1 addition & 0 deletions components/validator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ If you have lots of validation errors, you can filter them by error code::
}

.. versionadded:: 3.3

The ``findByCodes()`` method was introduced in Symfony 3.3.

Retrieving a Validator Instance
Expand Down
1 change: 1 addition & 0 deletions components/var_dumper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ option. Read more about this and other options in
.. tip::

.. versionadded:: 3.3

The local search box was introduced in Symfony 3.3.

If the dumped contents are complex, consider using the local search box to
Expand Down
Loading