8000 [Review] Added detailed Backwards Compatibility Promise text by webmozart · Pull Request #3439 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[Review] Added detailed Backwards Compatibility Promise text #3439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 39 commits into from
Feb 20, 2014
Merged

[Review] Added detailed Backwards Compatibility Promise text #3439

Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
840073c
Added detailed BC promise text
webmozart Jan 7, 2014
7320ed0
Updated BC promise to be valid as of Symfony 2.3
webmozart Jan 7, 2014
dacd7ce
Rearranged rules to be more easily understandable
webmozart Jan 7, 2014
79ca9f7
Added information about type compatibility
webmozart Jan 8, 2014
0e925cb
Added tables with safe operations
webmozart Jan 8, 2014
44ecf16
Fixed: No parameters must be added (ever) to API class methods
webmozart Jan 8, 2014
afadaab
Changed: The last parameters of a method may be removed
webmozart Jan 8, 2014
345410c
Rearranged safe operations to make more sense
webmozart Jan 8, 2014
a3ad08c
Removed most of the "cannot" statements which are repeated in the tab…
webmozart Jan 8, 2014
31ab2db
Improved wording
webmozart Jan 8, 2014
502ed95
Added: Some breaking changes to unsafe operations are documented in t…
webmozart Jan 8, 2014
4c5a55d
Rearranged page to have different sections for different user bases
webmozart Jan 8, 2014
c6e850d
Language fixes
webmozart Jan 8, 2014
db76288
Fixed headings
webmozart Jan 8, 2014
54fd836
Language improvements
webmozart Jan 8, 2014
00c6ebe
Fixed safety statements
webmozart Jan 8, 2014
efd3911
Added that adding custom properties is not safe
webmozart Jan 8, 2014
dcbe79a
Improved wording
webmozart Jan 9, 2014
af3a645
Added note about requesting `@api` tags
webmozart Jan 9, 2014
be76644
Added information about internal classes and interfaces
webmozart Jan 9, 2014
dfb3e8b
Improved wording
webmozart Jan 9, 2014
6501a35
Added information about changing return types that are classes or int…
webmozart Jan 9, 2014
0c6420f
Added information about changing parameter types
webmozart Jan 9, 2014
69768dd
Improved wording: use -> call, access
webmozart Jan 10, 2014
5a160c5
Added note about deprecated interfaces/classes
webmozart Jan 10, 2014
ef1f021
Added note about test classes
webmozart Jan 10, 2014
6d9edf1
Improved wording: Changed "safe" to "guaranteed"
webmozart Jan 23, 2014
8c6c7bf
Simplified usage description
webmozart Jan 23, 2014
4868452
Added prose about the difference between regular/API classes/interfaces
webmozart Jan 23, 2014
e11335f
Improved the wording of the "Using Symfony" section
webmozart Jan 24, 2014
25443c0
Improved table formatting
webmozart Feb 12, 2014
11bb879
Grammar
webmozart Feb 12, 2014
fd1d912
Typo
webmozart Feb 12, 2014
bdd3c03
Implemented changes suggested by @WouterJ
webmozart Feb 15, 2014
2320906
Extracted duplicated text into _api_tagging.rst.inc
webmozart Feb 15, 2014
90c4de6
Mentioned Semantic Versioning in the introduction
webmozart Feb 20, 2014
be2251c
Implemented @fabpot's comments
webmozart Feb 20, 2014
ce58ee9
Added rules for adding parent interfaces and moving methods/propertie…
webmozart Feb 20, 2014
0717192
Removed useless line break
webmozart Feb 20, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added information about changing parameter types
  • Loading branch information
@webmozart
webmozart committed Jan 9, 2014
commit 0c6420fbaae571f4a2723f6cd82c68229eed05c5
35 changes: 26 additions & 9 deletions contributing/code/bc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ Add default value to a parameter Yes [2]_ No
Remove default value of a parameter No No
Add type hint to a parameter No No
Remove type hint of a parameter Yes [2]_ No
Change return type Yes [2]_ [4]_ No
Change parameter type Yes [2]_ [4]_ No
Change return type Yes [2]_ [5]_ No
============================================== ============== ==============


Expand All @@ -211,7 +212,7 @@ Remove entirely No No
Make final Yes [2]_ No
Make abstract No No
Change name or namespace No No
Change parent class Yes [5]_ Yes [5]_
Change parent class Yes [6]_ Yes [6]_
Add interface Yes Yes
Remove interface No No
**Public Properties**
Expand All @@ -237,9 +238,10 @@ Add parameter with a default value Yes [2]_ No
Remove parameter Yes [3]_ Yes [3]_
Add default value to a parameter Yes [2]_ No
Remove default value of a parameter No No
Add type hint to a parameter Yes [6]_ No
Add type hint to a parameter Yes [7]_ No
Remove type hint of a parameter Yes [2]_ No
Change return type Yes [2]_ [4]_ No
Change parameter type Yes [2]_ [4]_ No
Change return type Yes [2]_ [5]_ No
**Protected Methods**
Add protected method Yes Yes
Remove protected method Yes [2]_ No
Expand All @@ -252,7 +254,8 @@ Add default value to a parameter Yes [2]_ No
Remove default value of a parameter Yes [2]_ No
Add type hint to a parameter Yes [2]_ No
Remove type hint of a parameter Yes [2]_ No
Change return type Yes [2]_ [4]_ No
Change parameter type Yes [2]_ [4]_ No
Change return type Yes [2]_ [5]_ No
================================================== ============== ==============


Expand All @@ -264,8 +267,22 @@ Change return type Yes [2]_ [4]_ No

.. [3] Only the last parameter(s) of a method may be removed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you mention that it won't break any code as PHP does not care if you pass too many arguments to a method call? Reassurance here is the key.


.. [4] The return type may only be changed to compatible types. The following
type changes are allowed:
.. [4] The parameter type may only be changed to a compatible or less specific
type. The following type changes are allowed:

=================== ==================================================================
Original Type New Type
=================== ==================================================================
boolean any `scalar type`_ with equivalent `boolean values`_
string any `scalar type`_ or object with equivalent `string values`_
integer any `scalar type`_ with equivalent `integer values`_
float any `scalar type`_ with equivalent `float values`_
class ``<C>`` any superclass or interface of ``<C>``
interface ``<I>`` any superinterface of ``<I>``
=================== ==================================================================

.. [5] The return type may only be changed to a compatible or more specific
type. The following type changes are allowed:

=================== ==================================================================
Original Type New Type
Expand All @@ -282,10 +299,10 @@ Change return type Yes [2]_ [4]_ No
interface ``<I>`` any subinterface or implementing class of ``<I>``
=================== ==================================================================

.. [5] When changing the parent class, the original parent class must remain an
.. [6] When changing the parent class, the original parent class must remain an
ancestor of the class.

.. [6] A type hint may only be added if passing a value with a different type
.. [7] A type hint may only be added if passing a value with a different type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@webmozart i think it would be useful to have links to the sami docu http://api.symfony.com/2.4/index.html and maybe direct links to interfaces per component. Right now is all spread out like butter but there are not further filters to actually allow for good usage for people that are implementing say only a component's interface set.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, the API docs need to be improved a lot for example to filter by @api tag, filter out internal methods and so much more. But I think that's outside of the scope of this PR. I want to get a good wording of the BC promise out first.

previously generated a fatal error.

.. _scalar type: http://php.net/manual/en/function.is-scalar.php
Expand Down
0