[wp-trac] [WordPress Trac] #35494: Add inline docs for unit test suite

[WordPress Trac]

#35494: Add inline docs for unit test suite
------------------------------+-------------------
 Reporter:  ericlewis         |       Owner:
     Type:  defect (bug)      |      Status:  new
 Priority:  normal            |   Milestone:  4.5
Component:  Build/Test Tools  |     Version:
 Severity:  normal            |  Resolution:
 Keywords:  has-patch         |     Focuses:  docs
------------------------------+-------------------

Comment (by ericlewis):

 Replying to [comment:8 DrewAPicture]:
 > Method descriptions, referred to as "summaries" in the standard, can
 wrap to up to an optional (though unusual) second line. We typically wrap
 lines at 80-120 characters depending on how far the gutter is indented.

 Cool — is there a rule of thumb we can use to decide where between 80 and
 120 we should wrap?

 > In the class DocBlock for `WP_UnitTestCase`, I see no reason for the
 extra blank lines, but it doesn't hurt anything to leave them.

 You mean in the long description, right? Should long descriptions
 typically not have double line breaks between lines?

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