Skip to content

Removes duplicated Deprecated and adds an example. #7243

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.

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

Closed
wants to merge 1 commit into from
Closed

Removes duplicated Deprecated and adds an example. #7243

wants to merge 1 commit into from

Conversation

dbrumann
Copy link
Contributor

Removes the duplicate "Deprecated" after @deprecated annotation as was asked in my PR symfony/symfony#20735. Also adds a randomly selected example that shows how the abstract XXX should look like and an edge case of trigger_error() when deprecating a whole class.

*/
class ArrayParserCache implements ParserCacheInterface

.. _ArrayParserCache: https://github.com/symfony/symfony/blob/9fc7306f7277ebf378b729bac3b42dfa55971af1/src/Symfony/Component/ExpressionLanguage/ParserCache/ArrayParserCache.php
Copy link
Member

Choose a reason for hiding this comment

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

I would change the link to point to the version in the 3.2 branch instead.

@@ -111,3 +111,21 @@ ready to cope with them (by adding a custom error handler like the one used by
the Web Debug Toolbar or by the PHPUnit bridge).

.. _`@-silencing operator`: https://php.net/manual/en/language.operators.errorcontrol.php

When deprecating a whole class the error should be placed between namespace and
use declarations, like in this example from ArrayParserCache_::
Copy link
Member

Choose a reason for hiding this comment

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

We always use additional backticks to enclose words that are part of a link role (even if it's just one word).

@xabbuh
Copy link
Member

xabbuh commented Dec 13, 2016

Thank you Denis.

xabbuh added a commit that referenced this pull request Dec 13, 2016
…ann)

This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #7243).

Discussion
----------

Removes duplicated Deprecated and adds an example.

Removes the duplicate "Deprecated" after `@deprecated` annotation as was asked in my PR symfony/symfony#20735. Also adds a randomly selected example that shows how the abstract `XXX` should look like and an edge case of `trigger_error()` when deprecating a whole class.

Commits
-------

a2c04e7 Deletes duplicate "Deprecated" and adds a more explicit example.
xabbuh added a commit that referenced this pull request Dec 13, 2016
@xabbuh xabbuh closed this Dec 13, 2016
xabbuh added a commit that referenced this pull request Dec 13, 2016
* 2.7:
  Use PHP 5.5's ::class notation
  [#7243] minor tweak
  Deletes duplicate "Deprecated" and adds a more explicit example.
xabbuh added a commit that referenced this pull request Dec 14, 2016
* 2.8:
  [#7220] some minor tweaks
  Use PHP 5.5's ::class notation
  [#7243] minor tweak
  Deletes duplicate "Deprecated" and adds a more explicit example.
  Accepted Suggestions
  Update 'query_builder' option
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Update guard_authentication.rst
  Use PHP 5.5's ::class notation
xabbuh added a commit that referenced this pull request Dec 14, 2016
* 3.1:
  [#7220] some minor tweaks
  Added "How to Use a Custom Version Strategy for Assets"
  Use PHP 5.5's ::class notation
  [#7243] minor tweak
  Deletes duplicate "Deprecated" and adds a more explicit example.
  Accepted Suggestions
  Update 'query_builder' option
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Update guard_authentication.rst
  Use PHP 5.5's ::class notation
xabbuh added a commit that referenced this pull request Dec 14, 2016
* 3.2: (22 commits)
  add missing config formats
  [#7224] fix indentation
  [#7220] some minor tweaks
  [#7196] add versionadded directive
  Explained how to improve the readability of long numeric literals
  Fix typo in workflow usage code lock
  Added "How to Use a Custom Version Strategy for Assets"
  Use PHP 5.5's ::class notation
  Update state-machines.rst
  [PHPUnitBridge] Fix copy/paste error
  [PHPUnitBridge] Fix copy/paste error
  [#7243] minor tweak
  Deletes duplicate "Deprecated" and adds a more explicit example.
  Accepted Suggestions
  Update 'query_builder' option
  Mentioned %env(...)% variables in Best Practices book
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Accepted suggestions in the guard documentation
  Update guard_authentication.rst
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants