[wp-trac] [WordPress Trac] #30483: Improve inline documentation in wp-admin/includes/ms.php

[WordPress Trac]

#30483: Improve inline documentation in wp-admin/includes/ms.php
--------------------------------+------------------------------
 Reporter:  dustyf              |       Owner:
     Type:  defect (bug)        |      Status:  new
 Priority:  normal              |   Milestone:  Future Release
Component:  Networks and Sites  |     Version:  trunk
 Severity:  normal              |  Resolution:
 Keywords:  has-patch           |     Focuses:  docs, multisite
--------------------------------+------------------------------
Changes (by jeremyfelt):

 * focuses:  docs => docs, multisite
 * version:  4.0.1 => trunk
 * milestone:  Awaiting Review => Future Release


Comment:

 Great stuff @dustyf, thanks!

 Notes:

 * All `@param` docs should have the type included (e.g `@param type $var
 Description.`). If the parameter is optional, this should be indicated as
 well. It looks like many of them are complete, but several are missing
 this data.
 * `@param` docs should also be space aligned when multiple exists. Again,
 it looks like many are there, but a few are still misaligned.
 * `update_user_status()` should probably be an `int` return type as it
 returns the `$value` it was passed.
 * `refresh_user_details()` could be clarified to show that `false` is
 returned if a user ID does not exist.

 @DrewAPicture may have more feedback as well.

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