[wp-trac] [WordPress Trac] #34035: Document $args parameter for plugins_api()

[WordPress Trac]

#34035: Document $args parameter for plugins_api()
--------------------------+---------------------------
 Reporter:  ocean90       |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  4.4
Component:  Plugins       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+---------------------------
Changes (by DrewAPicture):

 * owner:   => DrewAPicture
 * status:  new => reviewing


Comment:

 [attachment:34035.2.patch] looks a lot better. The keyword we typically
 use with booleans is "whether", so "Whether to return ___. Default true",
 for instance. I can fix that on commit.

 After some discussion with @ocean90, I think our best course of action is
 to provide supplementary information on success object structs as an
 "Explanation" on the function reference page. This would be instead of
 trying to jam all of that into the inline docs. The major upside is that
 we generally have a lot more control over formatting, external linking,
 etc. in the WordPress editor on DevHub than we do in hash notations
 currently.

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