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

Fixed documentation for -s option. #328

Merged

Conversation

joachim-n
Copy link
Contributor

Description

Fixes an error in the documentation for the -s option, which says 'sniff codes' when the command actually outputs error codes.

Suggested changelog entry

Related issues/external references

Fixes #319.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

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.

Thanks @joachim-n !

@jrfnl jrfnl added this to the 3.9.0 milestone Feb 5, 2024
@jrfnl jrfnl merged commit 675d8f3 into PHPCSStandards:master Feb 5, 2024
40 checks passed
@jrfnl
Copy link
Member

jrfnl commented Feb 5, 2024

@joachim-n The changelog usually contains the full name of contributors. Which name would you like me to use for you ? If you don't want to share your name, I can just use your GitHub handle, if you prefer.

@joachim-n
Copy link
Contributor Author

My full name's Joachim Noreiko. Thanks!

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.

docs and output are unclear on what counts as a sniff code
2 participants