8000 added blank line after .. versionadded:: directive · symfony/symfony-docs@ec17bff · GitHub
[go: up one dir, main page]

Skip to content

Commit ec17bff

Browse files
committed
added blank line after .. versionadded:: directive
1 parent e3acce7 commit ec17bff

File tree

95 files changed

+152
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+152
-0
lines changed

best_practices/configuration.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ through environment variables:
209209
password: "%env(DB_PASSWORD)%"
210210
211211
.. versionadded:: 3.2
212+
212213
Support for runtime environment variables via the ``%env(...)%`` syntax
213214
was added in Symfony 3.2. Prior to version 3.2, you needed to use the
214215
:doc:`special SYMFONY__ variables </configuration/external_parameters>`.

bundles/extension.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ Adding Classes to Compile
130130
-------------------------
131131

132132
.. versionadded:: 3.3
133+
133134
This technique is discouraged and the ``addClassesToCompile()`` method was
134135
deprecated in Symfony 3.3 because modern PHP versions make it unnecessary.
135136

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

140141
.. versionadded:: 3.2
142+
141143
The ``addAnnotatedClassesToCompile()`` method was added in Symfony 3.2.
142144

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

176178
.. versionadded:: 3.2
179+
177180
The option to add classes to compile using patterns was introduced in Symfony 3.2.
178181

179182
The classes to compile can also be added using file path patterns::

components/cache.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The Cache Component
1515
from/to `Doctrine Cache`_.
1616

1717
.. versionadded:: 3.3
18+
1819
The PSR-16 "Simple Cache" implementation was introduced in Symfony 3.3.
1920

2021
Installation

components/cache/adapters/memcached_adapter.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ helper method allows creating and configuring a `Memcached`_ class instance usin
6969
));
7070

7171
.. versionadded:: 3.4
72+
7273
The feature to pass configuration options in the memcached DSN was
7374
introduced in Symfony 3.4.
7475

components/cache/cache_invalidation.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Using Cache Tags
2121
----------------
2222

2323
.. versionadded:: 3.2
24+
2425
Tags-based invalidation was introduced in Symfony 3.2.
2526

2627
To benefit from tags-based invalidation, you need to attach the proper tags to

components/cache/cache_pools.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ when all items are successfully deleted)::
141141
$ php bin/console cache:pool:clear cache.validation cache.app
142142
143143
.. versionadded:: 3.4
144+
144145
Starting from Symfony 3.4, the ``cache:clear`` command no longer clears
145146
the cache pools, so you must use the ``cache:pool:clear`` command to
146147
delete them.

components/config/definition.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ Or you may define a prototype for each node inside an array node::
188188
;
189189

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

201202
.. versionadded:: 3.3
203+
202204
The ``castToArray()`` helper was added in Symfony 3.3.
203205

204206
Sometimes, to improve the user experience of your application or bundle, you may

components/console/events.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ The ``ConsoleEvents::EXCEPTION`` Event
8787
--------------------------------------
8888

8989
.. versionadded:: 3.3
90+
9091
The ``ConsoleEvents::EXCEPTION`` event was deprecated in Symfony 3.3. Use
9192
the ``ConsoleEvents::ERROR`` event instead.
9293

components/console/helpers/questionhelper.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,7 @@ convenient for passwords::
230230
}
231231

232232
.. versionadded:: 3.3
233+
233234
The ``QuestionHelper::disableStty()`` method was introduced in Symfony 3.3.
234235

235236
Normalizing the Answer
@@ -369,6 +370,7 @@ from the command line, you need to set the inputs that the command expects::
369370
}
370371

371372
.. versionadded:: 3.2
373+
372374
The ``CommandTester::setInputs()`` method was introduced in Symfony 3.2.
373375

374376
By calling :method:`Symfony\\Component\\Console\\Tester\\CommandTester::setInputs`,

components/console/logger.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ Errors
107107
------
108108

109109
.. versionadded:: 3.2
110+
110111
The ``hasErrored()`` method was introduced in Symfony 3.2.
111112

112113
The Console logger includes a ``hasErrored()`` method which returns ``true`` as

components/console/usage.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ command that match), then no command will be run and some suggestions of
158158
the possible commands to choose from will be output.
159159

160160
.. versionadded:: 3.4
161+
161162
Case-insensitivity of command shortcuts was introduced in Symfony 3.4. In
162163
previous Symfony versions, shortcuts had to match the case of the original
163164
command name (e.g. ``d:g`` was not the same shortcut as ``D:G``).

components/dependency_injection/compilation.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,7 @@ been run, use::
424424
);
425425

426426
.. versionadded:: 3.2
427+
427428
The option to prioritize compiler passes was added in Symfony 3.2.
428429

429430
You can also control the order in which compiler passes are run for each

components/dom_crawler.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,7 @@ The crawler supports multiple ways of adding the content::
254254
``ISO-8859-1`` in case no charset can be guessed.
255255

256256
.. versionadded:: 3.4
257+
257258
The charset guessing mechanism of the ``addContent()`` method was
258259
introduced in Symfony 3.4. In previous Symfony versions, the ``ISO-8859-1``
259260
charset was always used.
@@ -300,6 +301,7 @@ Expression Evaluation
300301
~~~~~~~~~~~~~~~~~~~~~
301302

302303
.. versionadded:: 3.2
304+
303305
The :method:`Symfony\\Component\\DomCrawler\\Crawler::evaluate` method was
304306
introduced in Symfony 3.2.
305307

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

445447
.. versionadded:: 3.3
448+
446449
Starting from Symfony 3.3, the optional ``formaction`` and ``formmethod``
447450
button attributes are supported. The ``getUri()`` and ``getMethod()``
448451
methods take into account those attributes to always return the right action

components/dotenv.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The Dotenv Component
99
stored in them accessible via ``getenv()``, ``$_ENV`` or ``$_SERVER``.
1010

1111
.. versionadded:: 3.3
12+
1213
The Dotenv component was introduced in Symfony 3.3.
1314

1415
Installation

components/event_dispatcher/container_aware_dispatcher.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The Container Aware Event Dispatcher
55
====================================
66

77
.. versionadded:: 3.3
8+
89
The ``ContainerAwareEventDispatcher`` class has been deprecated in Symfony 3.3
910
and it will be removed in Symfony 4.0. Use ``EventDispatcher`` with
1011
closure-proxy injection instead.

components/expression_language/caching.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ ones and injecting this using the constructor::
3838
$expressionLanguage = new ExpressionLanguage($cache);
3939

4040
.. versionadded:: 3.2
41+
4142
PSR-6 caching support was introduced in Symfony 3.2. Prior to version 3.2,
4243
a
4344
:class:`Symfony\\Component\\ExpressionLanguage\\ParserCache\\ParserCacheInterface`

components/expression_language/extending.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ register::
101101
ExpressionFunction::fromPhp('My\strtoupper', 'my_strtoupper');
102102

103103
.. versionadded:: 3.3
104+
104105
The ``ExpressionFunction::fromPhp()`` method was introduced in Symfony 3.3.
105106

106107
You can register providers using

components/filesystem.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ readlink
213213
~~~~~~~~
214214

215215
.. versionadded:: 3.2
216+
216217
The :method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` method was introduced in Symfony 3.2.
217218

218219
:method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` read links targets.
@@ -299,6 +300,7 @@ appendToFile
299300
~~~~~~~~~~~~
300301

301302
.. versionadded:: 3.3
303+
302304
The :method:`Symfony\\Component\\Filesystem\\Filesystem::appendToFile`
303305
method was introduced in Symfony 3.3.
304306

components/filesystem/lock_handler.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ LockHandler
22
===========
33

44
.. versionadded:: 3.4
5+
56
The ``LockHandler`` class was deprecated in Symfony 3.4 and it will be
67
removed in Symfony 4.0. Use :ref:`SemaphoreStore <lock-store-semaphore>`
78
or :ref:`FlockStore <lock-store-flock>` from the Lock component instead.

components/finder.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ There are lots of ways to filter and sort your results. You can also use the
8181
there's any file or directory matching the search criteria.
8282

8383
.. versionadded:: 3.4
84+
8485
The ``hasResults()`` method was introduced in Symfony 3.4.
8586

8687
Location

components/form.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ to bootstrap or access Twig and add the :class:`Symfony\\Bridge\\Twig\\Extension
223223
->getFormFactory();
224224

225225
.. versionadded:: 1.30
226+
226227
The ``Twig\\RuntimeLoader\\FactoryRuntimeLoader`` was introduced in Twig 1.30.
227228

228229
The exact details of your `Twig Configuration`_ will vary, but the goal is

components/http_foundation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@ Note you can create a
391391
value using :method:`Symfony\\Component\\HttpFoundation\\Cookie::fromString`.
392392

393393
.. versionadded:: 3.3
394+
394395
The ``Cookie::fromString()`` method was introduced in Symfony 3.3.
395396

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

541542
.. versionadded:: 3.3
543+
542544
The ``Stream`` class was introduced in Symfony 3.3.
543545

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

595597
.. versionadded:: 3.2
598+
596599
The :method:`Symfony\\Component\\HttpFoundation\\JsonResponse::fromJsonString`
597600
method was added in Symfony 3.2.
598601

components/lock.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The Lock Component
99
exclusive access to a shared resource.
1010

1111
.. versionadded:: 3.4
12+
1213
The Lock component was introduced in Symfony 3.4.
1314

1415
Installation

components/options_resolver.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,7 @@ using ``instanceof``). Additionally, you can validate all items in an array
337337
recursively by suffixing the type with ``[]``.
338338

339339
.. versionadded:: 3.4
340+
340341
Validating types of array items recursively was introduced in Symfony 3.4.
341342
Prior to Symfony 3.4, only scalar values could be validated.
342343

components/phpunit_bridge.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ Modified PHPUnit script
541541
-----------------------
542542

543543
.. versionadded:: 3.2
544+
544545
This modified PHPUnit script was introduced in the 3.2 version of
545546
this component.
546547

components/process.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ for new output before going to the next iteration::
8080
}
8181

8282
.. versionadded:: 3.2
83+
8384
The ``getIterator()`` method was introduced in Symfony 3.2.
8485

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

105106
.. versionadded:: 3.3
107+
106108
The ability to define commands as arrays of arguments was introduced in
107109
Symfony 3.3.
108110

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

420422
.. versionadded:: 3.1
423+
421424
The ability to pass a callback to these methods when output is disabled
422425
was added in Symfony 3.1.
423426

components/property_info.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ and plural property names::
274274
$propertyInfo->isWritable(SomeClass::class, 'feet'); // returns true
275275

276276
.. versionadded:: 3.2
277+
277278
The support of adder/remover methods was introduced in Symfony 3.2.
278279

279280
.. tip::

components/routing.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,7 @@ Unicode Routing Support
384384
~~~~~~~~~~~~~~~~~~~~~~~
385385

386386
.. versionadded:: 3.2
387+
387388
UTF-8 support for route paths and requirements was introduced in
388389
Symfony 3.2.
389390

components/security/firewall.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ Firewall Config
9292
~~~~~~~~~~~~~~~
9393

9494
.. versionadded:: 3.2
95+
9596
The ``FirewallConfig`` class was in 741A troduced in Symfony 3.2.
9697

9798
The information about a given firewall, such as its name, provider, context,

components/serializer.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ needs three parameters:
166166
#. The encoder used to convert that information into an array
167167

168168
.. versionadded:: 3.3
169+
169170
Support for the ``allow_extra_attributes`` key in the context was introduced
170171
in Symfony 3.3.
171172

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

603604
.. versionadded:: 3.4
605+
604606
The ability to handle parent classes for ``PropertyNormalizer`` was
605607
introduced in Symfony 3.4.
606608

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

625627
.. versionadded:: 3.2
628+
626629
Support for specifying datetime format during denormalization was
627630
introduced in the ``DateTimeNormalizer`` in Symfony 3.2.
628631

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

637640
.. versionadded:: 3.4
641+
638642
The ``DateIntervalNormalizer`` normalizer was added in Symfony 3.4.
639643

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

663667
.. versionadded:: 3.2
668+
664669
The ``YamlEncoder`` and ``CsvEncoder`` encoders were introduced in Symfony 3.2
665670

666671
.. _component-serializer-handling-circular-references:

components/stopwatch.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ while it is still running.
5151
$stopwatch = new Stopwatch(true);
5252

5353
.. versionadded:: 3.4
54+
5455
Full precision support was introduced in Symfony 3.4.
5556

5657
You can also provide a category name to an event::

components/translation/usage.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,7 @@ Adding Notes to Translation Contents
437437
------------------------------------
438438

439439
.. versionadded:: 3.4
440+
440441
The feature to load and dump translation notes was introduced in Symfony 3.4.
441442

442443
Sometimes translators need additional context to better decide how to translate

components/validator.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ If you have lots of validation errors, you can filter them by error code::
6565
}
6666

6767
.. versionadded:: 3.3
68+
6869
The ``findByCodes()`` method was introduced in Symfony 3.3.
6970

7071
Retrieving a Validator Instance

components/var_dumper.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ option. Read more about this and other options in
114114
.. tip::
115115

116116
.. versionadded:: 3.3
117+
117118
The local search box was introduced in Symfony 3.3.
118119

119120
If the dumped contents are complex, consider using the local search box to

0 commit comments

Comments
 (0)
0