-
Notifications
You must be signed in to change notification settings - Fork 801
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
codesniffer: Stop suppressing Commenting.WrongStyle in Jetpack-Tests #37290
Conversation
Phan depends on doc comments using `/**` openers. While we often don't bother with doc comments in tests, where we do have them we should format them correctly. The existing cases mostly fell into a few categories: * Actual doc comments. * "Section" separators being confused for function comments. Converted these to a `/** ... **/` style to make the sniff happy with them. * Useless comments about how to use `phpunit --filter`. Removed these. * Useless comments basically repeating the test function name. Removed these too.
Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.
Interested in more tips and information?
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available. Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped. Jetpack plugin: The Jetpack plugin has different release cadences depending on the platform:
If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack. |
…37290) Phan depends on doc comments using `/**` openers. While we often don't bother with doc comments in tests, where we do have them we should format them correctly. The existing cases mostly fell into a few categories: * Actual doc comments. * "Section" separators being confused for function comments. Converted these to a `/** ... **/` style to make the sniff happy with them. * Useless comments about how to use `phpunit --filter`. Removed these. * Useless comments basically repeating the test function name. Removed these too.
Proposed changes:
Phan depends on doc comments using
/**
openers. While we often don't bother with doc comments in tests, where we do have them we should format them correctly.The existing cases mostly fell into a few categories:
/** ... **/
style to make the sniff happy with them.phpunit --filter
. Removed these.Other information:
Jetpack product discussion
None. But see #37122 where chasing missing WrongStyle sniffs led to another fix.
Does this pull request change what data or activity we track or use?
No
Testing instructions: