Skip to content

Ensure comments example follows the standard#121

Open
opr wants to merge 1 commit intoWordPress:masterfrom
opr:patch-1
Open

Ensure comments example follows the standard#121
opr wants to merge 1 commit intoWordPress:masterfrom
opr:patch-1

Conversation

@opr
Copy link

@opr opr commented Dec 5, 2022

In https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/#comments it states

Comments come before the code to which they refer, and should always be preceded by a blank line.

The second example does not follow this rule. The // Do stuff comment is not preceded by a blank line.

I did not add a period here because I do not believe it is a "full sentence".

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