[wp-trac] [WordPress Trac] #28558: Add a link to unit tests in function comment block

[WordPress Trac]

#28558: Add a link to unit tests in function comment block
------------------------------+-----------------------------
 Reporter:  pbearne           |      Owner:
     Type:  feature request   |     Status:  new
 Priority:  normal            |  Milestone:  Awaiting Review
Component:  Build/Test Tools  |    Version:
 Severity:  normal            |   Keywords:
  Focuses:                    |
------------------------------+-----------------------------
 Hi all

 There should a link in the comment of a function to point to the location
 of Unit test for that function.

 There is no defined way to find a unit test for a function.
 The choices are:
 Guess and look files names that look right
 Search the test folder
 look in a coverage report

 I feel it would easier if the a link in the comment block

 {{{
 /*
 * @unitTest folder/file
 */
 }}}

 The link should relative the test folder

 This we make it easy to see which functions have tests and easy to find
 and read or run them.

 This will also help promote that we have tests :-)

 Paul

--
Ticket URL: <https://core.trac.wordpress.org/ticket/28558>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform