NamingConventions/ValidFunctionName: update XML documentation #2531
Conversation
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
GaryJones
approved these changes
Jun 13, 2025
jrfnl
approved these changes
Jun 14, 2025
Member
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
Nice finds @rodrigoprimo ! LGTM.
Once PR #2532 has been merged, this can be rebased and merged.
…e examples This commit fixes two code examples in the XML doc for the `WordPress.NamingConventions.ValidFunctionName` sniff that were missing the `function` keyword when declaring a method.
…rscore prefix This is one of the errors that the sniff generates, it was mentioned in the XML documentation description, but there was no <code_comparison> block for it.
rodrigoprimo
force-pushed
the
fix-valid-function-name-doc
branch
from
afbe218 to
9c8606e
Compare
Collaborator
Author
|
Rebased without changes to get a passing build. |
Member
|
Thanks for that @rodrigoprimo ! I'll merge it now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR implements the following changes to the XML documentation of the
WordPress.NamingConventions.ValidFunctionNamesniff: