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.

Sign up for GitHub

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

Jump to bottom

Ensure comments example follows the standard #121

Open

opr wants to merge 1 commit into WordPress:master from opr:patch-1

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".


          Ensure comments example follows the rules

244d947

dingo-d approved these changes

View reviewed changes

dingo-d added the Type: Documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment