[wp-trac] [WordPress Trac] #20495: Update phpDoc to reflect post id or object is valid

WordPress Trac noreply at wordpress.org
Mon Sep 23 14:59:56 UTC 2013

#20495: Update phpDoc to reflect post id or object is valid
 Reporter:  coffee2code   |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Future Release
Component:  Inline Docs   |     Version:  3.3.1
 Severity:  trivial       |  Resolution:
 Keywords:  needs-patch   |

Comment (by DrewAPicture):

 Replying to [comment:16 GaryJ]:
 > According to the [https://github.com/phpDocumentor/fig-
 standards/blob/master/proposed/phpdoc.md#7-describing-hashes draft PSR],
 all of the Inline PHPDoc bits (the array keys) should still be proceeded
 with a `$` for readability and parsability. The latest commit here uses
 `'foobar'` instead of `$foobar`.

 This is intentional. Please see the
 /php-documentation-standards/#1-1-parameters-that-are-arrays documenting
 functional argument arrays] section of the WordPress inline documentation

 WordPress uses a customized documentation schema that draws inspiration
 from PHPDoc, but that does not directly adhere to the PSR-*/FIG spec. We
 use our [https://github.com/rmccue/WP-Parser own parser] and our
 /php-documentation-standards/ own standards].

 If you have a suggestion or constructive criticism, I invite you to join
 us for the weekly inline-docs chat, held Wednesdays at 18:00 UTC in
 #wordpress-sfd on Freenode.

Ticket URL: <http://core.trac.wordpress.org/ticket/20495#comment:17>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software

More information about the wp-trac mailing list