Skip to content

Commit bdd3c03

Browse files
committed
Implemented changes suggested by @wouterj
1 parent fd1d912 commit bdd3c03

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

contributing/code/bc.rst

+11-12
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ Our Backwards Compatibility Promise
22
===================================
33

44
If you are using Symfony, we promise you backwards compatibility (BC) for all
5-
major releases (2.x, 3.x, ...). Ensuring smooth upgrades of your projects is our
5+
minor releases (2.5, 2.6, etc.). Ensuring smooth upgrades of your projects is our
66
first priority. However, backwards compatibility comes in many different flavors.
77

8-
.. note::
8+
.. caution::
99

1010
This promise was introduced with Symfony 2.3 and does not apply to previous
1111
versions of Symfony.
@@ -29,10 +29,10 @@ All interfaces shipped with Symfony can be used in type hints. You can also call
2929
any of the methods that they declare. We guarantee that we won't break code that
3030
sticks to these rules.
3131

32-
.. note::
32+
.. caution::
3333

3434
The exception to this rule are interfaces tagged with ``@internal``. Such
35-
interfaces should never be used or implemented.
35+
interfaces should *never* be used or implemented.
3636

3737
If you want to implement an interface, you should first make sure that the
3838
interface is an API interface. You can recognize API interfaces by the ``@api``
@@ -47,6 +47,8 @@ tag in their source code::
4747
*/
4848
interface HttpKernelInterface
4949
{
50+
// ...
51+
}
5052

5153
If you implement an API interface, we promise that we won't ever break your
5254
code. Regular interfaces, by contrast, should never be implemented, because if
@@ -86,12 +88,12 @@ Using Our Classes
8688
All classes provided by Symfony may be instantiated and accessed through their
8789
public methods and properties.
8890

89-
.. note::
91+
.. caution::
9092

9193
Classes, properties and methods that bear the tag ``@internal`` as well as
9294
the classes located in the various ``*\\Tests\\`` namespaces are an
93-
exception to this rule. They are meant for internal use only and should not
94-
be accessed by your own code.
95+
exception to this rule. They are meant for internal use only and should
96+
*never* be accessed by your own code.
9597

9698
Just like with interfaces, we also distinguish between regular and API classes.
9799
Like API interfaces, API classes are marked with an ``@api`` tag::
@@ -105,6 +107,8 @@ Like API interfaces, API classes are marked with an ``@api`` tag::
105107
*/
106108
class Request
107109
{
110+
// ...
111+
}
108112

109113
The difference between regular and API classes is that we guarantee full
110114
backwards compatibility if you extend an API class and override its methods. We
@@ -304,13 +308,8 @@ Change return type Yes [2]_ [5]_ No
304308
previously generated a fatal error.
305309
306310
.. _scalar type: http://php.net/manual/en/function.is-scalar.php
307-
308311
.. _boolean values: http://php.net/manual/en/function.boolval.php
309-
310312
.. _string values: http://www.php.net/manual/en/function.strval.php
311-
312313
.. _integer values: http://www.php.net/manual/en/function.intval.php
313-
314314
.. _float values: http://www.php.net/manual/en/function.floatval.php
315-
316315
.. _new ticket on GitHub: https://github.com/symfony/symfony/issues/new

0 commit comments

Comments
 (0)