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

fix(docs): change filter arguments to match PascalCase #3879

Merged
merged 2 commits into from
Aug 27, 2023

Conversation

simonsan
Copy link
Contributor

@simonsan simonsan commented Aug 21, 2023

Description

It fixes documentation of the command-line interface for the filter command.

Suggested changelog entry

Change documentation of filter command to match internally used PascalCase

Related issues/external references

Fixes #3877

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.

Copy link
Contributor

@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 for the PR @simonsan! Could you also make the same change on line 1406 (same file) ?

@simonsan
Copy link
Contributor Author

@jrfnl Done :)

Copy link
Contributor

@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.

Thank you @simonsan !

The changelog normally contains the full name of the contributor. Would you mind sharing yours ?

@simonsan
Copy link
Contributor Author

simonsan commented Aug 22, 2023

Hey there, yes, as a privacy activist I wouldn't share my full name on the internet. 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). 👍🏽

@jrfnl
Copy link
Contributor

jrfnl commented Aug 27, 2023

Hey there, yes, as a privacy activist I wouldn't share my full name on the internet. 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). 👍🏽

Thanks for letting me know @simonsan and I fully respect that. I'll just credit you by your GitHub handle in that case (presuming that's okay ?).

@jrfnl jrfnl added this to the 3.8.0 milestone Aug 27, 2023
@jrfnl jrfnl merged commit b6264f9 into squizlabs:master Aug 27, 2023
jrfnl added a commit that referenced this pull request Aug 27, 2023
jrfnl pushed a commit that referenced this pull request Aug 27, 2023
The filter names are case-sensitive (depending on OS), so the help texts should display the case which will be accepted on all OS-es.
@simonsan simonsan deleted the new-fix branch August 27, 2023 17:23
@jrfnl
Copy link
Contributor

jrfnl commented Dec 8, 2023

FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release.

As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo).

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.

--filter={gitmodified, gitstaged} is case-sensitive
3 participants