Skip to content
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

Squiz.Commenting.VariableComment doesn't allow @deprecated in variable docblock #2355

Open
mwgamble opened this issue Jan 8, 2019 · 3 comments

Comments

@mwgamble
Copy link

mwgamble commented Jan 8, 2019

It would be nice to be able to specify @deprecated for a class property, but currently this is banned by the Squiz VariableComment sniff.

I've read over some older github issues created for similar requests, and I can understand why you would be reluctant to modify the Squiz standard to accommodate additional tags. In this case, it would be nice if the processMemberVar() method in the relevant class could be broken up so that it is easier to override just the relevant part that checks for allowed tags. Alternatively, maybe the list of allowed tags can be made configurable?

Regardless of which outcome is chosen, I'd be happy to work on a patch to make this possible.

Thanks for all the great work you've all put in to PHPCS over the years, I'm incredibly grateful.

@jrfnl
Copy link
Contributor

jrfnl commented Jan 8, 2019

Related to #2222 which should make this a whole lot easier (and which I'm already working on behind the scenes in combination with #2189) ;-)

@mwgamble
Copy link
Author

mwgamble commented Jan 8, 2019

👍 I'll keep an eye on those issues. Thanks for all your hard work in the latest release by the way!

@neclimdul
Copy link

this was a surprise to me today. seems this was filed before 3.x was released and before some merges that could support it. Is it something that could happen now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants