We currently exclude quite a few coding standards rules. Most of these rules are related to docblock and comment styling. Some require updates to code and tests. This issue is a mega issue to track all of the updates that should be made.
To see files that need updates, check the phpcs.xml file and delete/comment out the corresponding rule. Then run composer run-script check-cs-errors.
When submitting pull requests to work on parts of this issue please submit PRs for no more than 15 files per PR. That means if you wish to update 100 files you'll need to submit 7 different PRs.
In the PR please Add Per #946 to the PR description to reference (but not close) this issue.
When making updates please adhere to our coding and documentation standards.
[ ] Add translation placeholder comments, currently excluded by <exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />
[ ] Inline parameter comments should end in a full stop, excluded by <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
[ ] Function parameter comments should end in a full stop, excluded by <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
[ ] Coment descriptions should start with a capital letter: <exclude name="Generic.Commenting.DocComment.LongNotCapital" /> and <exclude name="Generic.Commenting.DocComment.ShortNotCapital" />
We currently exclude quite a few coding standards rules. Most of these rules are related to docblock and comment styling. Some require updates to code and tests. This issue is a mega issue to track all of the updates that should be made.
To see files that need updates, check the phpcs.xml file and delete/comment out the corresponding rule. Then run
composer run-script check-cs-errors
.When submitting pull requests to work on parts of this issue please submit PRs for no more than 15 files per PR. That means if you wish to update 100 files you'll need to submit 7 different PRs.
In the PR please Add
Per #946
to the PR description to reference (but not close) this issue.When making updates please adhere to our coding and documentation standards.
[ ] Add translation placeholder comments, currently excluded by
<exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />
[ ] Inline parameter comments should end in a full stop, excluded by
<exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
[ ] Function parameter comments should end in a full stop, excluded by
<exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
[ ] Coment descriptions should start with a capital letter:
<exclude name="Generic.Commenting.DocComment.LongNotCapital" />
and<exclude name="Generic.Commenting.DocComment.ShortNotCapital" />
[ ] File header comments should obey documentation standards:
<exclude name="LifterLMS.Commenting.FileComment.PackageTagOrder" />
<exclude name="LifterLMS.Commenting.FileComment.SinceTagOrder" />
<exclude name="LifterLMS.Commenting.FileComment.MissingSinceTag" />
<exclude name="LifterLMS.Commenting.FileComment.MissingVersionTag" />
<exclude name="LifterLMS.Commenting.FileComment.VersionTagOrder" />
<exclude name="LifterLMS.Commenting.FileComment.MissingPackageTag" />
<exclude name="LifterLMS.Commenting.FileComment.DuplicateSinceTag" />
<exclude name="Squiz.Commenting.FileComment.Missing" />
<exclude name="Squiz.Commenting.FileComment.MissingSinceTag" />
<exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
<exclude name="Squiz.Commenting.FileComment.SpacingAfterComment" />
<exclude name="Squiz.Commenting.ClassComment.Missing" />
[ ] Function and method comments should obey documentation standards:
<exclude name="Squiz.Commenting.FunctionComment.Missing" />
<exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
<exclude name="Squiz.Commenting.FunctionComment.MissingParamTag" />
<exclude name="Squiz.Commenting.FunctionComment.MissingParamName" />
<exclude name="Squiz.Commenting.VariableComment.Missing" />
<exclude name="Squiz.Commenting.FunctionComment.InvalidReturnVoid" />
[x]
<exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch" />
Fixed in #1321