Fix typos and Coding standard #431
Conversation
akkspros
requested review from
adamsilverstein,
felixarntz,
mitogh and
JustinyAhin
as code owners
mukeshpanchal27
added
[Type] Documentation
|
Nice catch. |
| @@ -408,7 +408,7 @@ function perflab_render_pointer() { | |||
| ?> | |||
| <script id="perflab-admin-pointer" type="text/javascript"> | |||
| jQuery( function() { | |||
| // Pointer Options | |||
| // Pointer Options. | |||
There was a problem hiding this comment.
This period is unnecessary, so let's remove.
There was a problem hiding this comment.
I think part of the standard is that all one-line comments end with a period.
Comments come before the code to which they refer, and should always be preceded by a blank line. Capitalize the first letter of the comment, and include a period at the end when writing full sentences
https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/#comments
There was a problem hiding this comment.
Hmm, interesting @mitogh! I guess I'd argue that this is not a "full sentence," but of course want to follow the coding standards.
There was a problem hiding this comment.
Yeah, it's correct that basically any doc comment needs to end with a period per WP doc standards.
There was a problem hiding this comment.
Hmm, interesting @mitogh! I guess I'd argue that this is not a "full sentence," but of course want to follow the coding standards.
Right, this is mostly because the way the standard assumes what "full sentence" means as is just any complete line. @bethanylang
mukeshpanchal27
removed
the
no milestone
felixarntz
added
the
no milestone
|
Removing the milestone here since this doesn't affect end users or any external integration point. |
fix some typos and coding standards
Checklist
[Focus]orInfrastructurelabel.[Type]label.no milestonelabel.