[6.x] Remove stale @param from wildcard() docblocks - #15119
Merged
Conversation
wildcard() takes only the tag part. Tags::__call() invokes it with that single argument, and all 35 implementations declare one parameter, so the documented $args/$arguments has nowhere to come from. Theme already noted its copy as "Unused".
darkdi
changed the title
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
2 participants
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.
Six
wildcard()docblocks document a second parameter the method does not take.src/Tags/In.php:10array $argswildcard($method)src/Tags/Can.php:10array $argswildcard($method)src/Tags/Is.php:10array $argswildcard($method)src/Tags/Glide.php:22array $argswildcard($method)src/Tags/ParentTags.php:16array $argswildcard($method)src/Tags/Theme.php:13array $argumentsUnusedwildcard($method)Tags::__call()dispatches with a single argument:and all 35
wildcard()implementations insrc/declare one parameter, so thereis nothing for the second tag to describe.
Themealready carried the noteUnusedon its copy.Removed those six lines. Comments only — no signature, call site, or behaviour is
touched, so no test covers it.
While looking at this I noticed a further 21
@paramtags elsewhere insrc/whose names don't match their signatures — mostly parameters that were renamed
(
Support/Arr.phpremoveNullValues,Assets/AssetFolder.phprename,Console/Processes/Process.phpwithoutLoggingErrors, and others). They're adifferent kind of change from this one, so I left them out. Happy to send them
separately if you want them.