[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 DrewAPicture):

 Replying to [comment:3 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].

 Yeah, I think that may have still been up in the air when I did the patch.
 I'll fix it.

 > 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.

 Needs to stay that way to as @nacin put it, make it "grep-able", besides,
 the parser, etc.

 > * In content-status.php: Filter says int, but passes a (legacy) string,
 we should change that to an int.

 Will do.

 > * 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)

 I'll take a look.

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

 We should probably pick one. Is there an "official" name for it? Theme
 Customizer?

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