[wp-trac] [WordPress Trac] #25645: Document return value from wp_get_sites()

[WordPress Trac]

#25645: Document return value from wp_get_sites()
--------------------------+------------------
 Reporter:  rmccue        |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  3.7
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |
--------------------------+------------------

Comment (by DrewAPicture):

 Replying to [comment:4 nacin]:
 > Replying to [comment:3 SergeyBiryukov]:
 > > I tend to agree with rmccue that listing the exact returned keys (or
 adding a `@see` reference if they're already listed somewhere else) would
 be helpful here.
 >
 > It looks like [attachment:25645.2.diff] does this, but would it make
 more sense as part of the @return block?

 Fully documenting the @return here has wide implications, as it would set
 a precedent for documenting returned arrays with hash notations. As far as
 I'm aware, this would be the first and only instance of such in core.

 I'm all for documenting all the things if it means reduced confusion, but
 I'm also all for consistency. If we do a hash notation here, the standard
 will need to be updated and we'll need to (eventually) do it everywhere an
 array is returned. Is that something we want to commit to?

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25645#comment:5>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software