Introduce more comprehensive docblock coverage #168
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #167
The
WordPress-Docs
ruleset implements Sniffs that conform to WordPress' documentation standards. However, that ruleset does not conform completely to our coding standards, and it is difficult to override external Sniff customisations in external standards.So, this PR removes that standard from our ruleset, and implements a set of rules that better conform with our coding standards. The rules remain heavily inspired by WordPress-Docs.
This PR also tidies up some of the comments in our ruleset.
This PR can be tested by running the following in terminal:
followed by