WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#25498 closed defect (bug) (fixed)

Hooks Docs: wp-admin/includes/schema.php

Reported by: johnafish Owned by: kpdesign
Milestone: 3.8 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description

Attached patch has docs for the populate_options action in wp-admin/includes/schema.php.

Attachments (5)

schema.php (33.0 KB) - added by johnafish 8 years ago.
Inline Hook Docs For: wp-admin/includes/schema.php
schema.patch (570 bytes) - added by johnafish 8 years ago.
Sorry about that, mind just slipped away. Will update other ticket similarly.
schema.php.patch (562 bytes) - added by johnafish 8 years ago.
Patch from wp root
25498.2.diff (1.1 KB) - added by kpdesign 8 years ago.
Second pass
25498.diff (1.7 KB) - added by DrewAPicture 8 years ago.
Clean up

Download all attachments as: .zip

Change History (14)

@johnafish
8 years ago

Inline Hook Docs For: wp-admin/includes/schema.php

#1 @DrewAPicture
8 years ago

  • Keywords needs-patch added; has-patch removed

Hi, can you please re-upload your patch in either .diff or .patch format?

@johnafish
8 years ago

Sorry about that, mind just slipped away. Will update other ticket similarly.

#2 @DrewAPicture
8 years ago

  • Keywords has-patch added; needs-patch removed

#3 @DrewAPicture
8 years ago

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

@johnafish
8 years ago

Patch from wp root

#4 @kpdesign
8 years ago

@jonafish: Thanks for the patch. :)

A few things I noticed that need fixed:

  • Please use tabs to indent the doc block from the left gutter rather than spaces (when needed).
  • Indent the doc block at the same level as the action or filter:
 	/**
	 * Fires before creating WordPress options and setting their default values.
	 *
	 * @since 2.6.0
	 */
	do_action( 'populate_options' );
  • The @since version for populate_actions should be 2.6.0. A good reference to use is Adam Brown's Hook Reference for finding the version a hook was added. If you are unable to find it, just use @since Unknown and we can try to trace it.
  • It's okay to space out the action or filter line to bring it inline with the coding standards. For example, do_action('populate_options'); can be changed to do_action( 'populate_options' );. That is the only whitespace fixes that should be done.

Could you make these changes and resubmit the patch? :)

#5 @DrewAPicture
8 years ago

  • Keywords needs-patch added; has-patch removed

@kpdesign
8 years ago

Second pass

#6 @kpdesign
8 years ago

  • Keywords has-patch added; needs-patch removed

#7 @kpdesign
8 years ago

25498.2.diff still applies cleanly.

@DrewAPicture
8 years ago

Clean up

#8 @DrewAPicture
8 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 3.8

25498.diff has a bit of clean up. Includes minor changes to the phpdoc for the parent function.

#9 @DrewAPicture
8 years ago

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

In 25938:

Inline documentation for hooks in wp-admin/includes/schema.php.

Props johnafish, kpdesign.
Fixes #25498.

Note: See TracTickets for help on using tickets.