Skip to content

Commit 06d83cd

Browse files
committed
Merge branch '3.4' into 4.2
* 3.4: Use the \".. deprecated::\" directive for deprecations use same order for all configuration-blocks Add precision on the concerned fields Correct a sentence meaning use :: instead of .. code-block:: php
2 parents 6f78a1f + 6518bc0 commit 06d83cd

File tree

9 files changed

+45
-33
lines changed

9 files changed

+45
-33
lines changed

components/expression_language/extending.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This method has 3 arguments:
2929
function;
3030
* **evaluator** - A function executed when the expression is evaluated.
3131

32-
.. code-block:: php
32+
Example::
3333

3434
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
3535

components/security/authorization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ recognizes several strategies:
4949
``unanimous``
5050
only grant access if none of the voters has denied access;
5151

52-
.. code-block:: php
52+
Usage of the available options in detail::
5353

5454
use Symfony\Component\Security\Core\Authorization\AccessDecisionManager;
5555

components/translation/usage.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,16 @@ is done just as before:
6767
</file>
6868
</xliff>
6969
70+
.. code-block:: yaml
71+
72+
'Hello %name%': Bonjour %name%
73+
7074
.. code-block:: php
7175
7276
return [
7377
'Hello %name%' => 'Bonjour %name%',
7478
];
7579
76-
.. code-block:: yaml
77-
78-
'Hello %name%': Bonjour %name%
79-
8080
.. note::
8181

8282
The placeholders can take on any form as the full message is reconstructed

contributing/documentation/format.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -168,21 +168,24 @@ of the linked resource (``namespace``, ``class`` or ``method``):
168168
169169
:phpfunction:`iterator_to_array`
170170
171-
New Features or Behavior Changes
172-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171+
New Features, Behavior Changes or Deprecations
172+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173173

174-
If you're documenting a brand new feature or a change that's been made in
175-
Symfony, you should precede your description of the change with a
176-
``.. versionadded:: 3.x`` directive and a short description:
174+
If you are documenting a brand new feature, a change or a deprecation that's
175+
been made in Symfony, you should precede your description of the change with
176+
the corresponding directive and a short description:
177+
178+
For a new feature or a behaviour change use the ``.. versionadded:: 3.x``
179+
directive:
177180

178181
.. code-block:: rst
179182
180183
.. versionadded:: 3.4
181184
182185
The special ``!`` template prefix was introduced in Symfony 3.4.
183186
184-
If you're documenting a behavior change, it may be helpful to *briefly* describe
185-
how the behavior has changed:
187+
If you are documenting a behavior change, it may be helpful to *briefly*
188+
describe how the behavior has changed:
186189

187190
.. code-block:: rst
188191
@@ -191,12 +194,21 @@ how the behavior has changed:
191194
Support for annotation routing without an external bundle was added in
192195
Symfony 3.4. Prior, you needed to install the SensioFrameworkExtraBundle.
193196
197+
For a deprecation use the ``.. deprecated:: 3.X`` directive:
198+
199+
.. code-block:: rst
200+
201+
.. deprecated:: 3.3
202+
203+
This technique is discouraged and the ``addClassesToCompile()`` method was
204+
deprecated in Symfony 3.3 because modern PHP versions make it unnecessary.
205+
194206
Whenever a new major version of Symfony is released (e.g. 3.0, 4.0, etc),
195207
a new branch of the documentation is created from the ``master`` branch.
196-
At this point, all the ``versionadded`` tags for Symfony versions that have
197-
a lower major version will be removed. For example, if Symfony 4.0 were
198-
released today, 3.0 to 3.4 ``versionadded`` tags would be removed from the new
199-
``4.0`` branch.
208+
At this point, all the ``versionadded`` and ``deprecated`` tags for Symfony
209+
versions that have a lower major version will be removed. For example, if
210+
Symfony 4.0 were released today, 3.0 to 3.4 ``versionadded`` and ``deprecated``
211+
tags would be removed from the new ``4.0`` branch.
200212

201213
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
202214
.. _Sphinx: http://sphinx-doc.org/

deployment/proxies.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,7 @@ In this case, you'll need to - *very carefully* - trust *all* proxies.
5959
other than your load balancers. For AWS, this can be done with `security groups`_.
6060

6161
#. Once you've guaranteed that traffic will only come from your trusted reverse
62-
proxies, configure Symfony to *always* trust incoming request:
63-
64-
.. code-block:: php
62+
proxies, configure Symfony to *always* trust incoming request::
6563

6664
// public/index.php
6765

reference/constraints/Uuid.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,6 @@ Basic Usage
2222

2323
.. configuration-block::
2424

25-
.. code-block:: yaml
26-
27-
# config/validator/validation.yaml
28-
App\Entity\File:
29-
properties:
30-
identifier:
31-
- Uuid: ~
32-
3325
.. code-block:: php-annotations
3426
3527
// src/Entity/File.php
@@ -45,6 +37,14 @@ Basic Usage
4537
protected $identifier;
4638
}
4739
40+
.. code-block:: yaml
41+
42+
# config/validator/validation.yaml
43+
App\Entity\File:
44+
properties:
45+
identifier:
46+
- Uuid: ~
47+
4848
.. code-block:: xml
4949
5050
<!-- config/validator/validation.xml -->

setup/built_in_web_server.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ you have to pass the correct location using the ``--docroot`` option:
109109
Stopping the Server
110110
-------------------
111111

112-
When you are finished, you can stop the web server using the ``server:stop``
113-
command:
112+
When you finish your work, you can stop the web server with the following command:
114113

115114
.. code-block:: terminal
116115

validation/groups.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,15 +132,18 @@ With this configuration, there are three validation groups:
132132

133133
``Default``
134134
Contains the constraints in the current class and all referenced classes
135-
that belong to no other group.
135+
that belong to no other group. In this example, it only contains the
136+
``city`` field.
136137

137138
``User``
138139
Equivalent to all constraints of the ``User`` object in the ``Default``
139140
group. This is always the name of the class. The difference between this
140141
and ``Default`` is explained in :doc:`/validation/sequence_provider`.
141142

142143
``registration``
143-
Contains the constraints on the ``email`` and ``password`` fields only.
144+
This is a custom validation group, so it only contains the constraints
145+
explicitly associated to it. In this example, only the ``email`` and
146+
``password`` fields.
144147

145148
Constraints in the ``Default`` group of a class are the constraints that have
146149
either no explicit group configured or that are configured to a group equal to

workflow/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ like this:
155155
],
156156
]);
157157
158-
.. code-block:: php
158+
As configured, the following property is used by the marking store::
159159

160160
class BlogPost
161161
{

0 commit comments

Comments
 (0)