-
-
Notifications
You must be signed in to change notification settings - Fork 62
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
[Documentation] PSR12 - Return Type Declaration #237
Conversation
There was a problem hiding this 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. |
There was a problem hiding this comment.
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) ?
There was a problem hiding this comment.
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 😅
There was a problem hiding this 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.
deec2db
to
da43b73
Compare
Rebased and squashed, merging once the build passes. |
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
PR checklist