Skip to content

[RFC] Add more forbiddenAnnotations #28

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 1 commit into from
Feb 11, 2018
Merged

[RFC] Add more forbiddenAnnotations #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions lib/Doctrine/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,15 @@
name="forbiddenAnnotations"
type="array"
value="
@api,
Copy link
Member

Choose a reason for hiding this comment

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

@api can be useful when dealing with BC promises or the lack thereof, but I don't think we use it for now, so it's probably ok to include it.

Copy link
Member

Choose a reason for hiding this comment

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

If it is public and it is not marked @internal then it is already API :P

Copy link
Member

Choose a reason for hiding this comment

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

Don't make it so simple!

Copy link
Member

Choose a reason for hiding this comment

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

It is that simple :P

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed, @api adds maintenance overhead. Any public or non-final protected is typically public API by design. At least it motivates devs to think about API & what should be exposed and what not (looking at you SF). 👍

@author,
@category,
@copyright,
@created,
@license,
@package,
@since,
@subpackage,
@version
"
/>
Expand Down