Replace ReturnsTag with DisallowedDocTags sniff #8
Conversation
thiemowmde
force-pushed
the
disallowedDocTags
branch
from
a1b8c29
to
f914ddd
Compare
| class Wikibase_Sniffs_Commenting_DisallowedDocTagsSniff implements PHP_CodeSniffer_Sniff { | ||
|
|
||
| /** | ||
| * @var array Set a value to null if a tag is forbidden, but no automatic fix should be made. |
There was a problem hiding this comment.
This needs to document which of key and value is the incorrect and which is the correct value, precisely because of the confusing inconsistency which makes it hard to infer this from the array value :)
There was a problem hiding this comment.
What are you missing? The pretty much only way to see this comment is when you look at the code. The defaults are there, directly below. They can be overridden via <properties>.
All that should be better documented, I agree. But this is for a later patch.
There was a problem hiding this comment.
The defaults are there, directly below.
Yes, and looking at the first defaults, I have no idea if @cover is a misspelling of @covers or @cover is the correct version of the misspelling @covers :) but I guess it’s more clear with the following entries, and allowing the null value only makes sense for one of those interpretations.
There was a problem hiding this comment.
Again, I'm not really sure what your question is. I made the list you can see here in the code based on tons of experience with this stuff, based on actual statistics I made with all our code bases (including core), and based on what PHPDoc.org as well as Doxygen describe. Bad tags left, good tags right.
As said, I will document this later.
There was a problem hiding this comment.
I updated the documentation. Hope this helps.
There was a problem hiding this comment.
Thanks, much better IMO :) immediately understandable now.
A tag named "@ticket" does not exist anywhere else. I found these while working on wmde/WikibaseCodeSniffer#8 Change-Id: I7519154e0ae3be5dcb68e15ed604de4a95354b02
thiemowmde
force-pushed
the
disallowedDocTags
branch
from
f914ddd
to
9517f30
Compare
thiemowmde
force-pushed
the
disallowedDocTags
branch
from
9517f30
to
bb41060
Compare
Found and fixed with wmde/WikibaseCodeSniffer#8 [1]. [1]: wmde/WikibaseCodeSniffer#8 Change-Id: I855fca0b4279f351802d05a6520cde747a3c13d0
This will soon be checked by our code sniffer, see wmde/WikibaseCodeSniffer#8 Change-Id: I4fe0aa4e5730d151919d3106c8ea75075118e42a
This is the canonical form, see wmde/WikibaseCodeSniffer#8 Change-Id: Iae69c5818fe33698c794b95d1b3e122115e2f208
This is split from #7, and will make a minor subset of the changes made in #7 obsolete. I will rebase #7 when this is merged.
I did run this new sniff on the Wikibase.git code base, and only found about a dozen violations, all of them intended (mostly
@licence).Note that this branch does not run the PHPCBF test. This will change with #7. This is intentional. I did not wanted to copy to much from #7, to not make this patch to complicated.