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.

Sign up for GitHub

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

Jump to bottom

Generic/CamelCapsFunctionName: improve code coverage #642

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Generic/CamelCapsFunctionName: improve code coverage #642

wants to merge 5 commits into from
+90 −50

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR improves code coverage for the Generic.NamingConventions.CamelCapsFunctionName sniff and makes the following minor changes to the sniff code:

  • Removes two incorrect code comments.
  • Update a code comment to better describe what it does.
  • Removes an unnecessary return; at the end of a method.

Related issues/external references

Part of #146

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.

@rodrigoprimo
Generic/CamelCapsFunctionName: remove two incorrect code comments
0066452 
This sniff only listens to `T_FUNCTION`. It does not listen to
`T_FN` or `T_CLOSURE`. So the removed code comments are incorrect. The if
conditions are still valid to bail early when live coding, but it does not
ever apply to closures or arrow functions.
@rodrigoprimo
Generic/CamelCapsFunctionName: update code comment
55c6faf 
The original inline comment was inaccurate as code removes all leading
underscores and not just the first.
@rodrigoprimo
Generic/CamelCapsFunctionName: remove unnecessary return
5fb0769 
`return;` is unnecessary as the last statement in a method.
@rodrigoprimo
Generic/CamelCapsFunctionName: rename test case file
2c66318 
Doing this to be able to create tests with syntax errors on separate
files.
@rodrigoprimo
Generic/CamelCapsFunctionName: improve code coverage
9ea58ef
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Standard: Generic Type: chores/QA
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rodrigoprimo