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] PSR12 - Return Type Declaration #237

Conversation

dingo-d
Copy link
Contributor

@dingo-d dingo-d commented Jan 8, 2024

The PR contains the documentation for the PSR12/Functions/ReturnTypeDeclaration sniff.

Description

This PR will add the documentation for the above-mentioned sniff, according to the official standard definitions.

Suggested changelog entry

Add documentation for the PSR12 ReturnTypeDeclaration 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.

Thanks for this PR @dingo-d !

Just one remark about the description. Everything else seems perfectly fine.

<documentation title="Return Type Declaration">
<standard>
<![CDATA[
For functions and closures, the return type declaration must be correctly defined.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a standards description, this feels quite non-descript.

What about using the PSR12 phrasing (phrase just above the third code sample in the section) ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update the description 👍🏼 This does feel a bit vague 😅

@jrfnl jrfnl added this to the 3.8.x Next milestone Jan 12, 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 for updating the description @dingo-d ! LGTM.

@jrfnl jrfnl force-pushed the documentation/PSR12-functions-return-type-declaration branch from deec2db to da43b73 Compare January 12, 2024 11:46
@jrfnl
Copy link
Member

jrfnl commented Jan 12, 2024

Rebased and squashed, merging once the build passes.

@jrfnl jrfnl merged commit b52d30b into PHPCSStandards:master Jan 12, 2024
38 checks passed
@jrfnl jrfnl modified the milestones: 3.8.x Next, 3.9.0 Jan 19, 2024
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