chore: restore commenting sniffs to PHPCS ruleset #2976
Merged
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
justlevine
added
Status: In Review
justlevine
changed the title
jasonbahl
requested changes
Nov 1, 2023
jasonbahl
reviewed
Nov 1, 2023
Co-authored-by: Jason Bahl <jasonbahl@mac.com>
jasonbahl
reviewed
Nov 1, 2023
src/Data/PostObjectMutation.php
Outdated
| * delete) | ||
| * @param \WPGraphQL\AppContext $context The AppContext passed down to all resolvers | ||
| * @param int $post_id $post_id The ID of the postObject being | ||
| * mutated |
There was a problem hiding this comment.
this line looks weird too?
There was a problem hiding this comment.
🤷🏻♂️ maying it's just the Github UI that makes it look off?
There was a problem hiding this comment.
Nah these indeed got messed up. 1 sec will push a fix.
|
Code Climate has analyzed commit f21a3ec and detected 0 issues on this pull request. View more on Code Climate. |
jasonbahl
approved these changes
Nov 1, 2023
Merged
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.
What does this implement/fix? Explain your changes.
This PR restores the
Squiz.CommentingPHPCS ruleset, and addresses the resulting smells.More specifically:
Squiz.Commenting.BlockComment,Squiz.Commenting.DocCommenting.Alignment,Squiz.FunctionComment.SpacingAfterParam, andSquiz.Commenting.InlineComment.NoSpaceBeforewere autofixed.@vartags,@paramsand their types,@throwstags.See additional comments for the remaining
Squiz.Commentingsmells that are now explicitly excluded.No production code has been changed in this PR
Does this close any currently open issues?
Any relevant logs, error output, GraphiQL screenshots, etc?
Any other comments?
Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunctionhas been removed from the ruleset as it is already included byWordPress.Generic.Commenting.DocComment.MissingShorthas been reclassified as "Should probably be added back".Squiz.Commenting.FunctionComment.IncorrectTypeHintthrows false positives when used in conjunction with FCQN. which is significantly more important in terms of IDE hinting.Squiz.Commenting.ClassComment.Missing,Squiz.Commenting.FileComment.Missing. These don't affect IDE hinting, and a lot of effort to add.Squiz.Commenting.FunctionComment.EmptyThrows,Squiz.Commenting.FunctionComment.MissingParamComment. While adding param explanations would be nice, this would be a lot of work to remediate. Saving for a future PR.Squiz.Commenting.InlineComment.InvalidEndChar, would be a lot of work to remediate for only formatting.Where has this been tested?
Operating System: Ubuntu 20.04 (wsl2 + devilbox + php8.1.15)
WordPress Version: 6.3.2