Fix WooCommerce hook comment phpcs errors in misc files #10126
Merged
+63
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Test the buildOption 1. Jetpack Beta
Option 2. Jurassic Ninja - available for logged-in A12s🚀 Launch a JN site with this branch 🚀 ℹ️ Install this Tampermonkey script to get more options. Build info:
Note: the build is updated when a new commit is pushed to this PR. |
|
Size Change: 0 B Total Size: 1.36 MB ℹ️ View Unchanged
|
shendy-a8c
approved these changes
Jan 13, 2025
There was a problem hiding this comment.
Tested well. After removing WooCommerce.Commenting excludes from phpcs.xml.dist, running npm run lint:php on base branch gives me bunch of errors on those files but no error when run on PR branch.
I notice includes/admin/class-wc-rest-payments-settings-controller.php is mentioned in the issue and PR but no change on that file so I assume that file was good all along.
@SInCE tag version numbers were calculated by viewing the PR that added the hook and looking at the WooPayments versions that included it
That must have quite tedious. Great work.
Honestly, I don't check whether the value of @SInCE is correct. I trust you did it correctly and it's low impact if the value is incorrect.
Yes, I see that PR #9329 removed the hooks that were violating comment phpcs rules after the initial audit was conducted. I've noted this in the PR description. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #8549
Changes proposed in this Pull Request
This PR fixes
WooCommerce.Commentingerrors from the following miscellaneous files:tests/unit/admin/test-class-wc-payments-admin-sections-overwrite.phpincludes/admin/class-wc-rest-payments-settings-controller.php– no changes were required here, hooks were removed in Temporarily disables custom field detection notices #9329includes/admin/class-wc-payments-admin.phptemplates/emails/plain/customer-ipp-receipt.phptemplates/emails/customer-ipp-receipt.phpNotes
@sincetag version numbers were calculated by viewing the PR that added the hook and looking at the WooPayments versions that included itphpcs:ignoreWooCommerce.Commentingignore declaration fromphpcs.xml.dist– this should be done once all errors have been fixed in Fix WooCommerce hook comment phpcs reports #8437.Testing instructions
Remove all the
WooCommerce.Commentingexcludes fromphpcs.xml.distRun
npm run lint:phpfor the files listed above:Ensure there are no errors
Inspect the hook descriptions added are accurate
npm run changelogto add a changelog file, choosepatchto leave it empty if the change is not significant. You can add multiple changelog files in one PR by running this command a few times.Post merge