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.

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

Jump to bottom

Introduce hooks doc block sniff #7

Open
Chouby opened this issue Aug 29, 2022 · 0 comments
Open

Introduce hooks doc block sniff #7

Chouby opened this issue Aug 29, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@Chouby
Copy link
Contributor

Chouby commented Aug 29, 2022

I'd like to check that all hooks are correctly documented.

Such sniff is currently not included in any of the rulesets that we rely on. There is a project to introduce one in WPCS, but it's currently planned for a "future release".

I have tested the sniff WooCommerce.Commenting.CommentHooks from https://github.com/woocommerce/woocommerce-sniffs/ but all comments such as /** This filter is documented in... */ are reported as errors, which is a no go for us.

Maybe we could write our own sniff, mixing the best of the 2 existing works.
@Chouby Chouby added the enhancement New feature or request label Aug 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Chouby