Add guideline that changing default values is a BC break #21371
+23
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xabbuh
approved these changes
Sep 13, 2025
wouterj
requested changes
Sep 13, 2025
Comment on lines
+139
to
+142
| | Change default value of an argument | No :ref:`[12] <note-12>` | | ||
| +-----------------------------------------------+-----------------------------+ | ||
| | Remove default value of an argument | No :ref:`[13] <note-13>` | | ||
| +-----------------------------------------------+-----------------------------+ |
There was a problem hiding this comment.
The BC promise consist of 2 main sections:
- The first part is "Using Symfony Code", here we explain "if you use an interface/class from Symfony and do this, you can expect your code to keep working"
- The second part is "Working on Symfony Code", where we explain which changes we and our contributors are allowed to make to Symfony interfaces/classes.
Given this table is part of the first section, we should either revert both of them or change the first to "Yes" and revert the last one.
If you change the default value when implementing an interface, no change in the interface will break your code. So it's OK to change the default value.
And removing a default value while the interface has a default value is not possible in PHP.
| @@ -288,7 +294,7 @@ Move to parent class Yes | |||
| Rename argument Yes :ref:`[10] <note-10>` | |||
| Remove argument No :ref:`[3] <note-3>` | |||
| Add default value to an argument No :ref:`[7] <note-7>` :ref:`[8] <note-8>` | |||
| Remove default value of an argument No | |||
| Remove default value of an argument No :ref:`[13] <note-13>` | |||
There was a problem hiding this comment.
Is there a reason not to add "Change default value of an argument No" here and for protected methods below?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.