[wp-trac] [WordPress Trac] #35065: Tests for docblock quality

WordPress Trac noreply at wordpress.org
Mon Dec 14 13:29:11 UTC 2015


#35065: Tests for docblock quality
------------------------------+------------------------------
 Reporter:  johnbillion       |       Owner:
     Type:  enhancement       |      Status:  new
 Priority:  normal            |   Milestone:  Awaiting Review
Component:  Build/Test Tools  |     Version:
 Severity:  normal            |  Resolution:
 Keywords:  has-patch         |     Focuses:  docs
------------------------------+------------------------------

Comment (by GaryJ):

 The rules that exist in WordPress-Docs were just the easy wins that
 utilised existing Sniffs that are part of existing standards that ship
 with PHPCS (i.e. Squiz and Generic) - see https://github.com/WordPress-
 Coding-Standards/WordPress-Coding-Standards/blob/develop/WordPress-
 Docs/ruleset.xml .

 This is in no-way comprehensive, and doesn't check for many WP
 idiosyncrasies. The ruleset.xml in fact is mainly made up of exclusions
 from those more typical existing standards, and would therefore need
 custom Sniffs to add those valid checks in.

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


More information about the wp-trac mailing list