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

[Documentation] Squiz.WhiteSpace.FunctionClosingBraceSpace #408

Conversation

przemekhernik
Copy link
Contributor

Description

This PR adds documentation for the Squiz.WhiteSpace.FunctionClosingBraceSpace sniff.

  • bin/phpcs --standard=Squiz --generator=text --sniffs=Squiz.WhiteSpace.FunctionClosingBraceSpace
  • bin/phpcs --standard=Squiz --generator=html --sniffs=Squiz.WhiteSpace.FunctionClosingBraceSpace
image image

Suggested changelog entry

Add documentation for the Squiz.WhiteSpace.FunctionClosingBraceSpace sniff.

Related issues/external references

Part of #148

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.

@przemekhernik Thank you for this PR and my apologies that it took me a while before I got to reviewing it.

Overall, this looks good. All errors accounted for and the code samples demonstrate the issues clearly.

There are just some grammatical nitpicks to fix and then I'm happy to merge this.

@jrfnl
Copy link
Member

jrfnl commented May 13, 2024

@przemekhernik Just checking in to see when you have time to finish this off ... ?

@przemekhernik przemekhernik requested a review from jrfnl May 15, 2024 17:22
@przemekhernik
Copy link
Contributor Author

Hi @jrfnl ! I'm sorry for the delay too! I completely missed the email with the notification. I've applied your great suggestions and it's ready to review 🤘

przemekhernik and others added 2 commits May 16, 2024 07:26
Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com>
@jrfnl jrfnl added this to the 3.10.0 milestone May 16, 2024
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 @przemekhernik for those updates and for contributing.

All good now. I will rebase the PR (without changes) and merge once the build has passed.

@jrfnl jrfnl force-pushed the documentation/Squiz-WhiteSpace-FunctionClosingBraceSpace branch from c8360ea to 889dfd4 Compare May 16, 2024 05:31
@jrfnl jrfnl merged commit 72b50b9 into PHPCSStandards:master May 16, 2024
40 checks passed
jrfnl pushed a commit that referenced this pull request May 16, 2024
* add docs for FunctionClosingBraceSpace sniff
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