[wp-meta] [Making WordPress.org] #233: Documenting data structures that have no class definitions

[Making WordPress.org]

#233: Documenting data structures that have no class definitions
---------------------------+----------------------
 Reporter:  Rarst          |       Owner:
     Type:  enhancement    |      Status:  closed
 Priority:  low            |   Milestone:
Component:  Developer Hub  |  Resolution:  invalid
 Keywords:                 |
---------------------------+----------------------
Changes (by coffee2code):

 * status:  new => closed
 * resolution:   => invalid


Comment:

 This seems more a core documentation issue than one for the Code
 Reference.

 We support a DocBlock syntax for the `@return` tag that allows for the
 description and definition of a return array or object and its elements.
 For example, see
 [https://developer.wordpress.org/reference/classes/wp_tax_query/get_sql_for_query/
 WP_Tax_Query::get_sql_for_query()], which returns an array with 'join' and
 'where' as keys.

 If the intent is to formalize things into actual data structures rather
 than relying on in-place documentation, then that also seems to be more of
 a request for core.

 Documentation on the Code Reference side of things can be initially made
 as a user contributed note, which could warrant being added as "More
 Information" (aka, an explanation).

 If I've misunderstood, please reopen and cite some specific examples of
 what you had in mind.

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/233#comment:3>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org