WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#25502 closed defect (bug) (fixed)

Hooks Docs: wp-admin/network.php

Reported by: johnafish Owned by: DrewAPicture
Milestone: 3.7 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch
Focuses: Cc:

Description

Attached patch has inline docs for allow_subdirectory_install filters in wp-admin/network.php

Attachments (1)

network.php.patch (577 bytes) - added by johnafish 7 years ago.
Patch from wp root

Download all attachments as: .zip

Change History (5)

#1 @DrewAPicture
7 years ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to DrewAPicture
  • Status changed from new to reviewing

Thanks for the patch. Some notes on 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 `@param` line.
  • For the parameter description, mirror the idea of the short description with "Whether to enable <this thing>. Default <default boolean value>."

#2 @johnafish
7 years ago

Thanks for all the help Drew, kind of new to this whole editing core thing.

@johnafish
7 years ago

Patch from wp root

#3 @DrewAPicture
7 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 3.7

network.php.patch looks great.

In the future, try to avoid overwriting patches on tickets as it removes context. If you name patches the same and upload them without checking the "override" box, Trac will automatically increment the file name for you :)

#4 @DrewAPicture
7 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 25722:

Inline documentation for hooks in wp-admin/network.php.

Props johnafish.
Fixes #25502.

Note: See TracTickets for help on using tickets.