WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#25500 closed defect (bug) (fixed)

Hooks Docs: wp-admin/maint/repair.php

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

Description

Patch contains comments for 'tables_to_repair' filter in wp-admin/maint/repair.php

Attachments (3)

repair-path.diff (1.1 KB) - added by ben.moody 8 years ago.
25500-patch-v2.diff (1.2 KB) - added by ben.moody 8 years ago.
25500.3.diff (687 bytes) - added by kpdesign 8 years ago.
Second pass on 25500-patch-v2.diff

Download all attachments as: .zip

Change History (8)

#1 @DrewAPicture
8 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#2 follow-up: @DrewAPicture
8 years ago

  • Keywords needs-patch added; has-patch removed

Hi, thanks for the patch. Some notes on repair-path.diff:

  • The suggested language for filter short descriptions is to say, "Filter <this thing>". The goal is to focus on what is filterable and not why it's filterable :)
  • So in this case, the what is which tables to to repair. And the default is an empty array, something that should be noted at the end of the parameter description (which is currently missing).

For more information on the style of hook docs we're looking for, check out the hooks section of the inline docs standards.

#3 in reply to: ↑ 2 @ben.moody
8 years ago

Replying to DrewAPicture:

Hi, thanks for the patch. Some notes on repair-path.diff:

  • The suggested language for filter short descriptions is to say, "Filter <this thing>". The goal is to focus on what is filterable and not why it's filterable :)
  • So in this case, the what is which tables to to repair. And the default is an empty array, something that should be noted at the end of the parameter description (which is currently missing).

For more information on the style of hook docs we're looking for, check out the hooks section of the inline docs standards.

Uploaded corrections to patch file, please find new file - 25500-patch-v2.diff.

Thanks.

@kpdesign
8 years ago

Second pass on 25500-patch-v2.diff

#4 @DrewAPicture
8 years ago

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

#5 @DrewAPicture
8 years ago

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

In 25725:

Inline documentation for hooks in wp-admin/maint/repair.php.

Props ben.moody, kpdesign.
Fixes #25500.

Note: See TracTickets for help on using tickets.