[wp-trac] [WordPress Trac] #50744: Add the WordPress-Docs standard to the PHPCS configuration

WordPress Trac noreply at wordpress.org
Mon Jul 27 21:06:48 UTC 2020

#50744: Add the WordPress-Docs standard to the PHPCS configuration
 Reporter:  johnbillion       |       Owner:  (none)
     Type:  task (blessed)    |      Status:  new
 Priority:  normal            |   Milestone:  Awaiting Review
Component:  Build/Test Tools  |     Version:  5.1
 Severity:  normal            |  Resolution:
 Keywords:  has-patch         |     Focuses:  docs, coding-standards

Comment (by jrf):

 @johnbillion I applaud the effort, thanks for taking this initiative.

 I'd like to suggest holding off on adding the ruleset to the
 `.phpcs.xml.dist` file at the moment.

 The current `WordPress-Docs` standard is far from complete, nor completely
 accurate and quite some work is needed to actually properly check the docs
 against the documentation standards as outlined in the handbook.

 Once the currently ongoing work for WPCS 3.0.0 is finished, improving the
 docs sniffs, or rather, writing new sniffs to allow us to check the docs
 properly is on the agenda, though it still be a while before I get to

 In the mean time, fixes to the existing docs, like the ones above, are of
 course encouraged, awesome and very welcome.

Ticket URL: <https://core.trac.wordpress.org/ticket/50744#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform

More information about the wp-trac mailing list