Allow extra param docs for functions#5
Merged
mikeybinns merged 1 commit intomainfrom Jul 2, 2025
Merged
Conversation
🦋 Changeset detectedLatest commit: d898a88 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
steve-brett
approved these changes
Jul 2, 2025
Contributor
steve-brett
left a comment
steve-brett
left a comment
There was a problem hiding this comment.
Nice, I've been thinking about this too and this is a neat solution.
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.
WordPress contains a lot of actions and filters which require having a function with parameters defined by WordPress. Sometimes we don't need to use all the parameters so we can leave them off the function, but it's easier to document all the parameters at once.
Allowing extra param docs allows us to include the documentation for unused parameters for later use, instead of having to add the variable and also document it on use.