[wp-trac] [WordPress Trac] #25532: Hooks Docs: wp-admin/edit-tags.php

[WordPress Trac]

#25532: Hooks Docs: wp-admin/edit-tags.php
---------------------------+------------------------------
 Reporter:  pauldewouters  |       Owner:
     Type:  enhancement    |      Status:  new
 Priority:  normal         |   Milestone:  Awaiting Review
Component:  Inline Docs    |     Version:
 Severity:  normal         |  Resolution:
 Keywords:  has-patch      |
---------------------------+------------------------------
Changes (by rzen):

 * cc: brian@… (added)


Comment:

 **Overall:**
 * Can you remove the non-hook-related edits you've made? (e.g. lines 9-11,
 131-134, 136-139, 260-262, 588-590)
 * `@since` tags should follow the 3-digit version notation, e.g. x.x.x
 * Instead of "Fires actions to be run..." phrase your short descriptions
 as "Fires before/after/during/...."
 * In your hash notations (e.g. lines 403, 415, 535, 547) you don't need to
 mention "Variables passed to the callback." because that is generic and
 applies to all hook params. Instead, a hash description should be unique
 to the hash it's describing.

 `'after-' . $taxonomy . '-table'`
 * Missing @since tag
 * Missing @param tag

 `add_category_form_pre`
 `add_link_category_form_pre`
 `add_tag_form_pre`
 * These three hooks were all deprecated at the introduction of
 `{$taxonomy}_pre_add_form`. Add `@deprecated 3.0.0 Use
 {$taxonomy}_pre_add_form instead.` to their docblocks, immediately after
 the `@since` tag (See [http://make.wordpress.org/core/handbook/inline-
 documentation-standards/php-documentation-standards/#1-2-deprecated-
 functions PHPDoc Standards]).
 * All three of their `@param` tags are incorrect, the data is being cast
 as an object, not an array, so we do not need the hash notation (which is
 a shame, because you wrote it quite well!).

 `edit_category_form`
 `edit_link_category_form`
 `add_tag_form`
 * These three hooks were all deprecated at the introduction of
 `{$taxonomy} _add_form `. Add `@deprecated 3.0.0 Use {$taxonomy} _add_form
 instead.` to their docblocks, immediately after the `@since` tag (See
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-2-deprecated-functions PHPDoc Standards]).
 * All three of their `@param` tags are incorrect, the data is being cast
 as an object, not an array, so we do not need the hash notation (which is
 a shame, because you wrote it quite well!).

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