[wp-trac] [WordPress Trac] #32246: Fix a variety of phpDoc issues

WordPress Trac noreply at wordpress.org
Thu Mar 17 07:52:14 UTC 2016

#32246: Fix a variety of phpDoc issues
 Reporter:  DrewAPicture    |       Owner:  DrewAPicture
     Type:  task (blessed)  |      Status:  assigned
 Priority:  low             |   Milestone:  Future Release
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs

Comment (by DrewAPicture):

 @ramiy on [attachment:class-wp-ajax-response.php.patch]:

 * For the `$args` parameter description, "to override the defaults" is a
 given. Maybe something like this instead: "Optional. An array or string of
 XML response arguments."
 * The `$action` argument description should indicate the boolean, i.e.
 "'''Whether to''' use a nonce. Default false."
 * In descriptions, we use ID vs id
 * For `$position`, listing out the accepted values and what they mean is
 helpful, but the description of what the argument represents is missing.
 * `$supplemental`: There should be backticks around `<supplemental>` in
 the description

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

More information about the wp-trac mailing list