Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for WordPress.NamingConventions.ValidVariableName #2457

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

richardkorthuis
Copy link
Contributor

Related to #1722

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @richardkorthuis, thanks for working on this PR and my apologies that it took me a while to get to reviewing it.

On the whole, looking good!

There are just two small remarks/questions:

  1. The inline remark about the second code comparison blocks missing the <em> tags.
  2. As the sniff flags both variable _declaration_s as well as the use of variables which don't comply, I'm wondering if it would make sense to add a second code sample to the code comparison with an echo statement using a variable or a function call being passed a variable ?

@richardkorthuis
Copy link
Contributor Author

@jrfnl I have added the extra code sample with an echo.

@jrfnl
Copy link
Member

jrfnl commented Aug 12, 2024

@jrfnl I have added the extra code sample with an echo.

Thanks for the update @richardkorthuis !

Looks good, I'd just like to combine the third code comparison with the first as they basically highlight the same issue. (A code comparison can contain multiple code samples within each <code> block).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants