Skip to content

Commit 233e8c5

Browse files
committed
[#2246] Minor tweaks to deprecations details in part thanks to @stof and @wouterj
1 parent a3b0897 commit 233e8c5

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

contributing/code/conventions.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ must be used instead (where ``XXX`` is the name of the related thing):
7777
"replaceXXX", on the other hand, cannot add new elements. If an unrecognized
7878
key as passed to "replaceXXX" it must throw an exception.
7979

80+
.. _contributing-code-conventions-deprecations:
81+
8082
Deprecations
8183
------------
8284

@@ -99,6 +101,9 @@ the feature was replaced.
99101

100102
A PHP ``E_USER_DEPRECATED`` error must also be triggered to help people with
101103
the migration starting one or two minor versions before the version where the
102-
feature will be removed (depending of the criticality of the removal)::
104+
feature will be removed (depending on the criticality of the removal)::
103105

104-
trigger_error('XXX() is deprecated since version 2.X and will be removed in 2.Y. Use XXX instead.', E_USER_DEPRECATED);
106+
trigger_error(
107+
'XXX() is deprecated since version 2.X and will be removed in 2.Y. Use XXX instead.',
108+
E_USER_DEPRECATED
109+
);

contributing/community/releases.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ Deprecations
9090
When a feature implementation cannot be replaced with a better one without
9191
breaking backward compatibility, there is still the possibility to deprecate
9292
the old implementation and add a new preferred one along side. Read the
93-
:doc:`conventions <../code/conventions>` document to learn more about how
94-
deprecations are handled in Symfony.
93+
:ref:`conventions<contributing-code-conventions-deprecations>` document to
94+
learn more about how deprecations are handled in Symfony.
9595

9696
Rationale
9797
---------

0 commit comments

Comments
 (0)