[wp-trac] [WordPress Trac] #25502: Hooks Docs: wp-admin/network.php

[WordPress Trac]

#25502: Hooks Docs: wp-admin/network.php
--------------------------+------------------------------
 Reporter:  johnafish     |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by DrewAPicture):

 * keywords:  has-patch => needs-patch
 * owner:   => DrewAPicture
 * status:  new => reviewing


Comment:

 Thanks for the patch. Some notes on [attachment:network.php.patch]:
 * Generally speaking, the suggested language for filter docs is to say
 "Filter <this thing>" rather than allude to what something "allows" or can
 do. So in this case, This filter enables subdirectory installs, which
 defaults to false. So another those lines, maybe something like "Filter
 whether to enable <this thing>."
 * Even filters with only a single parameter still need an
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-functions-and-class-methods `@param`
 line].
 * For the parameter description, mirror the idea of the short description
 with "Whether to enable <this thing>. Default <default boolean value>."

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