WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#29734 closed defect (bug) (fixed)

Improve inline docs for check_comment()

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: Comments Keywords: has-patch
Focuses: docs Cc:

Description

Need to do:

  • Remove duplication of the 'number of links' phrase in the function docblock
  • Format params
  • Add the alternative return of false to the @return tag
  • Fix various inline comment syntax

Attachments (2)

29734.diff (2.6 KB) - added by DrewAPicture 7 years ago.
Main docblock fixes
29734.2.diff (2.8 KB) - added by DrewAPicture 7 years ago.
Inline comment fixes

Download all attachments as: .zip

Change History (4)

@DrewAPicture
7 years ago

Main docblock fixes

@DrewAPicture
7 years ago

Inline comment fixes

#1 @DrewAPicture
7 years ago

In 29762:

Improve documentation in the check_comments() docblock.

  • Removes two duplicate sentences from the long description
  • Tightens up phrasing elsewhere in the long description for specific checks
  • Clarifies the parameter and return descriptions, and adds periods

See #29734.

#2 @DrewAPicture
7 years ago

  • Owner set to DrewAPicture
  • Resolution set to fixed
  • Status changed from new to closed

In 29763:

Improve and clarify inline commenting inside the check_comment() function.

Adds logical explanations of what some of the various comment checks are checking for, as well as some general cleanup and syntax fixes.

Fixes #29734.

Note: See TracTickets for help on using tickets.