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 FileName sniff #2492

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

Conversation

Nic-Sevic
Copy link

Related to #1722

  • docs/Files/FileNameStandard.xml

@jrfnl jrfnl mentioned this pull request Sep 17, 2024
61 tasks
Copy link
Collaborator

@rodrigoprimo rodrigoprimo left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, @Nic-Sevic! Usually, a <standard> and <code_comparison> block should be created for each of the error/warnings generated by the sniff, but there are some exceptions. Did you intentionally combine everything in a single <standard> and <code_comparison> pair? Without thinking too much about it, I'm more inclined to think that it would be better to separate the error/warning messages.

I just noticed that what I shared above is not mentioned in #1722, so there is a big change you were not aware of that (cc @jrfnl in case we should add this information in the issue description or maybe link to https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/CONTRIBUTING.md#writing-sniff-documentation). That is my bad.

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