[wp-trac] [WordPress Trac] #25256: Docs standards for Bundled Themes

[WordPress Trac]

#25256: Docs standards for Bundled Themes
---------------------------+------------------
 Reporter:  DrewAPicture   |       Owner:
     Type:  defect (bug)   |      Status:  new
 Priority:  normal         |   Milestone:  3.7
Component:  Bundled Theme  |     Version:
 Severity:  normal         |  Resolution:
 Keywords:  has-patch      |
---------------------------+------------------

Comment (by obenland):

 Hey Drew, thanks for that. A couple of notes:

 The short description of functions
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-functions-and-class-methods should always
 end with a period].

 In [attachment: twentytwelve.diff]:
 * Can we update the docs, so that `//duplicate_hook` gets a space between
 the slashes and the word? Or would that break parsing? Looks ugly.
 * In content-status.php: Filter says int, but passes a (legacy) string, we
 should change that to an int.
 * In image.php: Would it satisfy the filter doc guidelines to not have the
 array passed as an argument to the filter, but still document the specific
 values? I understand that this is how the example in the guidelines work,
 but we should just omit the variable name in the documentation, IMO. (Same
 for Twenty Thirteen)

 In [attachment: twentythirteen.diff]:
 * In functions.php: Is it the Customizer or the Theme Customizer?

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