Skip to content

Conversation

@jaymcp
Copy link
Contributor

@jaymcp jaymcp commented Oct 20, 2025

Description

Replaces Squiz.Commenting.FunctionComment Sniff with extended version under the BigBiteDocs namespace.
Behaviourally, this new Sniff suggests int and bool as the correct type hints when doing type checking, rather than integer and boolean as in the Squiz Sniff, to adhere to Big Bite's coding standard more correctly.

We used to exclude several error codes from the Squiz Sniff, which we no longer do, now that we've introduced our version of the Sniff.
Because this is likely to result in lots of instances of the ParamCommentNotCapital and ParamCommentFullStop error codes, this PR also adds fixers for this, to make the adoption process more straightforward.

Types of changes (if applicable):

  • 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 not work as expected).

Checklist (if applicable):

  • All checks pass when running composer run all-checks.

- Capitalisation of first letter in param/throws/return descriptions
- Terminating full stop in param/throws/return descriptions
@jaymcp jaymcp changed the title Add fixers for function comments Replace Squiz.Commenting.FunctionComment with new Sniff Oct 20, 2025
@jaymcp jaymcp merged commit 412f409 into main Oct 20, 2025
6 checks passed
@jaymcp jaymcp deleted the feat/function-comment-fixer branch October 20, 2025 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants