[Contracts] [PHPUnitBridge] Document the "symfony/deprecation-contracts" #14669
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
OskarStark
reviewed
Dec 8, 2020
OskarStark
reviewed
Dec 8, 2020
components/phpunit_bridge.rst
Outdated
| @@ -165,6 +165,9 @@ Deprecation notices can be triggered by using:: | |||
|
|
|||
| @trigger_error('Your deprecation message', E_USER_DEPRECATED); | |||
|
|
|||
| You can also require the `symfony/deprecation-contracts` that provide the global | |||
| function `trigger_deprecation()` for this usage. | |||
There was a problem hiding this comment.
Suggested change
| function `trigger_deprecation()` for this usage. | |
| ``trigger_deprecation()`` function for this usage. |
I would rather use:
:method:`\Symfony\........::trigger_deprecation`here
There was a problem hiding this comment.
let me find an example in the codebase @OskarStark :)
There was a problem hiding this comment.
hum in fact there is no namespace etc, it is a global func, so what path should i write?
There was a problem hiding this comment.
Lets keep it like this then, thanks!
OskarStark
reviewed
Dec 8, 2020
OskarStark
approved these changes
Dec 8, 2020
|
Thank you Antoine. |
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.
When reading this doc, I remembered this package, i think it can be useful to document it here