WordPress.org

Making WordPress.org

Opened 9 months ago

Closed 6 weeks ago

#3233 closed defect (fixed)

Inline comments must end in full-stops,exclamation marks, or question marks missing wp standard in doc

Reported by: mp518 Owned by: obenland
Milestone: Priority: normal
Component: Support Forums Keywords: has-patch
Cc:

Description

Inline comments must end in full-stops,exclamation marks, or question marks as per WordPress standard.

Attachments (1)

3233.patch (1.3 KB) - added by mp518 9 months ago.
correct

Download all attachments as: .zip

Change History (5)

@mp518
9 months ago

correct

#1 follow-up: @Otto42
9 months ago

  • Milestone Plugin Directory v3.0 deleted
  • Resolution set to invalid
  • Status changed from new to closed

#2 in reply to: ↑ 1 ; follow-up: @netweb
9 months ago

  • Resolution invalid deleted
  • Status changed from closed to reopened

Replying to Otto42:

The WordPress standard has no such rule.

https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#5-inline-comments
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#5-1-single-line-comments

It does actually, the example given // Allow plugins to filter an array. includes a full-stop at the end of the line, it is also enforced by the WordPress PHPCS ruleset.

Also:

#3 in reply to: ↑ 2 @mp518
8 months ago

Agree with you @netweb

#4 @obenland
6 weeks ago

  • Owner set to obenland
  • Resolution set to fixed
  • Status changed from reopened to closed

In 7293:

Forums: Add trailing period to comments.

Props mp518.
Fixes #3233.

Note: See TracTickets for help on using tickets.