Skip to content

Commit d0802a8

Browse files
committed
-
1 parent 94cca88 commit d0802a8

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

contributing/code/bc.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ covered by our backward compatibility promise:
136136
+-----------------------------------------------+-----------------------------+
137137
| Add a default value to an argument | Yes |
138138
+-----------------------------------------------+-----------------------------+
139+
| Change default value of an argument | No :ref:`[12] <note-12>` |
140+
+-----------------------------------------------+-----------------------------+
141+
| Remove default value of an argument | No :ref:`[13] <note-13>` |
142+
+-----------------------------------------------+-----------------------------+
139143
| Call a private method (via Reflection) | No |
140144
+-----------------------------------------------+-----------------------------+
141145
| Access a private property (via Reflection) | No |
@@ -211,7 +215,8 @@ Add argument without a default value No
211215
Add argument with a default value No
212216
Remove argument No :ref:`[3] <note-3>`
213217
Add default value to an argument No
214-
Remove default value of an argument No
218+
Change default value of an argument No :ref:`[12] <note-12>`
219+
Remove default value of an argument No :ref:`[13] <note-13>`
215220
Add type hint to an argument No
216221
Remove type hint of an argument No
217222
Change argument type No
@@ -265,7 +270,7 @@ Add argument with a default value Yes
265270
Remove argument No :ref:`[3] <note-3>`
266271
Add default value to an argument Yes
267272
Change default value of an argument No :ref:`[12] <note-12>`
268-
Remove default value of an argument No
273+
Remove default value of an argument No :ref:`[13] <note-13>`
269274
Add type hint to an argument No
270275
Remove type hint of an argument Yes
271276
Change argument type No
@@ -289,7 +294,7 @@ Move to parent class Yes
289294
Rename argument Yes :ref:`[10] <note-10>`
290295
Remove argument No :ref:`[3] <note-3>`
291296
Add default value to an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
292-
Remove default value of an argument No
297+
Remove default value of an argument No :ref:`[13] <note-13>`
293298
Add type hint to an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
294299
Remove type hint of an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
295300
Change argument type No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
@@ -309,7 +314,7 @@ Move to parent class Yes
309314
Rename argument Yes :ref:`[10] <note-10>`
310315
Remove argument No :ref:`[3] <note-3>`
311316
Add default value to an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
312-
Remove default value of an argument No :ref:`[7] <note-7>`
317+
Remove default value of an argument No :ref:`[13] <note-13>` :ref:`[7] <note-7>`
313318
Add type hint to an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
314319
Remove type hint of an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
315320
Change argument type No :ref:`[7] <note-7>` :ref:`[8] <note-8>`
@@ -383,7 +388,7 @@ Move to used trait
383388
:ref:`Add argument with a default value <add-argument-public-method>` No
384389
Remove argument No
385390
Add default value to an argument No
386-
Remove default value of an argument No
391+
Remove default value of an argument No :ref:`[13] <note-13>`
387392
Add type hint to an argument No
388393
Remove type hint of an argument No
389394
Change argument type No
@@ -400,7 +405,7 @@ Move to used trait
400405
:ref:`Add argument with a default value <add-argument-public-method>` No
401406
Remove argument No
402407
Add default value to an argument No
403-
Remove default value of an argument No
408+
Remove default value of an argument No :ref:`[13] <note-13>`
404409
Add type hint to an argument No
405410
Remove type hint of an argument No
406411
Change argument type No
@@ -415,7 +420,7 @@ Add argument without a default value
415420
Add argument with a default value No
416421
Remove argument No
417422
Add default value to an argument No
418-
Remove default value of an argument No
423+
Remove default value of an argument No :ref:`[13] <note-13>`
419424
Add type hint to an argument No
420425
Remove type hint of an argument No
421426
Change argument type No
@@ -496,6 +501,11 @@ code when upgrading to newer Symfony versions.
496501
**[12]** Changing a default value is a BC break because it changes the behavior
497502
of existing code that relies on the current default value.
498503

504+
.. _note-13:
505+
506+
**[13]** Removing a default value is a BC break because it makes previously
507+
optional arguments required, breaking existing code that doesn't pass all arguments.
508+
499509
Making Code Changes in a Backward Compatible Way
500510
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501511

0 commit comments

Comments
 (0)