[wp-trac] [WordPress Trac] #25551: Hook Docs: wp-mail.php

[WordPress Trac]

#25551: Hook Docs: wp-mail.php
--------------------------+------------------------------
 Reporter:  radices       |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by ericlewis):

 * keywords:  has-patch => needs-patch


Comment:

 Hi radices,

 thanks for the preliminary patch. Please see
 [make.wordpress.org/core/handbook/inline-documentation-standards/php-
 documentation-standards/ our inline documentation standards] and conform
 your patch to it.

 Some issues are

 * General line spacing. First docblock line should be blank, line break
 between short description and @since tag.
 * do_action should start with 'Fires after...' or something similar. See
 the inline docs standard.
 * Document all arguments sent through the hooks.
 * Do not modify any other core functionality, we're just doing docs here
 (here you replace add_magic_quotes() with wp_slash()

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