[wp-trac] [WordPress Trac] #29734: Improve inline docs for check_comment()

[WordPress Trac]

#29734: Improve inline docs for check_comment()
--------------------------+-------------------
 Reporter:  DrewAPicture  |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  4.1
Component:  Comments      |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+-------------------

Comment (by DrewAPicture):

 In [changeset:"29762"]:
 {{{
 #!CommitTicketReference repository="" revision="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.
 }}}

--
Ticket URL: <https://core.trac.wordpress.org/ticket/29734#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform