Skip to content

Generic/OpeningFunctionBraceBsdAllman: improve XML documentation #953

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

Generic/OpeningFunctionBraceBsdAllman: fix syntax errors in the XML doc code examples

Generic/OpeningFunctionBraceBsdAllman: improve XML doc

  • <documentation> title matches the sniff name.
  • Mention in the <standard> description that there must be no content on the line after the opening brace and make some other minor adjustments to the description text.
  • Improve the title of the <code> blocks.

Suggested changelog entry

Generic.Functions.OpeningFunctionBraceBsdAllman: minor fixes and 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.

- `<documentation>` title matches the sniff name.
- Mention in the `<standard>` description that there must be no content
on the line after the opening brace and makes some other minor
adjustments to the description text.
- Improve the title of the `<code>` blocks.
@rodrigoprimo
Copy link
Contributor Author

The remark error seems unrelated to the changes in this PR: https://github.com/PHPCSStandards/PHP_CodeSniffer/actions/runs/14359341840/job/40256467629?pr=953

@jrfnl
Copy link
Member

jrfnl commented Apr 9, 2025

The remark error seems unrelated to the changes in this PR

Should be fixed via #954 (once merged)

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 !

@jrfnl jrfnl added this to the 3.12.2 milestone Apr 13, 2025
@jrfnl jrfnl merged commit 71fcf9a into PHPCSStandards:master Apr 13, 2025
49 of 50 checks passed
@jrfnl jrfnl deleted the documentation-opening-function-brace-bsd-allman branch April 13, 2025 01:50
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