-
Notifications
You must be signed in to change notification settings - Fork 651
Add Periods to end comments, @params and @returns #1702
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.
I haven't ever seen periods at the end of the type, only when there's a comment too. Can you clarify where else in core follows this pattern?
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.
Hey, @danielbachhuber !
Periods at the end of the type are the part of standard WordPress PHP documentation in the Core handbook. You can check this information here https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#1-functions-class-methods
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.
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.
@danielbachhuber Though it does mention Use a period at the end.
What do you think about that? Let me know. I'll follow your lead.
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.
Only add a period if there's actually a description, please. Better yet, add descriptions where they're missing, and then you can add a period to that :)
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.
@danielbachhuber Got it, re-submitting the corrected version.
|
@danielbachhuber Kindly, take a look. |
|
🚢 🚢 🚢 |
In accordance with WP PHP documentation standards Add Periods to end comments, @params and @returns