Skip to content

Squiz/FunctionOpeningBraceSpace: update XML doc #1098

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

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR updates the XML documentation of the Squiz.WhiteSpace.FunctionOpeningBraceSpace sniff to address the following:

  • Update the sniff description and remove a code example for something that the sniff doesn't check. The sniff only checks for blank lines after the opening brace of a function, and not if the opening brace is on its own line.
  • Ensure the title matches the sniff name.

Suggested changelog entry

Squiz.WhiteSpace.FunctionOpeningBraceSpace: improvements to the XML documentation

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.

- Update the sniff description and remove a code example for something
that the sniff doesn't check. The sniff only checks for blank lines
after the opening brace of a function, and not if the opening brace is
on its own line.
- Ensure the <documentation> title matches the sniff name.
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 @rodrigoprimo !

For the record: there did use to be a "opening brace on same line/new line" check for JS. This was removed in 34543c8.

@jrfnl jrfnl added this to the 3.13.1 milestone May 18, 2025
@jrfnl jrfnl merged commit bc1e0a5 into PHPCSStandards:master May 18, 2025
50 checks passed
@jrfnl jrfnl deleted the documentation-function-opening-brace-space branch May 18, 2025 01:59
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