Add RemoveEventSubscriberDescriptionFixer#40
Merged
Conversation
…ocks Removes docblock descriptions on event subscriber methods where the words only repeat the method name plus "event", e.g. a "Delete lead event" description on onLeadDelete(LeadEvent $event).
Restrict removal to public methods and strip just the matching description line, preserving @param/@return tags instead of skipping the whole docblock.
Member
Author
|
Looks good 👍 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds a custom fixer that removes redundant docblock descriptions on event subscriber methods.
When a docblock description is just the method-name words plus "event", it carries no information and gets removed:
becomes:
Matching is order-independent and ignores the common
onhandler prefix. Docblocks carrying any@annotation are left untouched. Registered inDocblockLevel.Covered by 3 fixture tests (positive + two skips). phpstan/rector/ecs all clean.