[wp-trac] [WordPress Trac] #26742: Misleading function description for get_taxonomy_template() in template.php

WordPress Trac noreply at wordpress.org
Mon Dec 30 18:45:15 UTC 2013


#26742: Misleading function description for get_taxonomy_template() in template.php
--------------------------+------------------
 Reporter:  UmeshSingla   |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  3.9
Component:  Inline Docs   |     Version:  3.8
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |
--------------------------+------------------

Comment (by DrewAPicture):

 I think doing this is a good idea, as dynamic hooks can be tough to track
 down. I also think this is an excellent use case for an `@uses
 get_query_template()` entry in each phpdoc to serve as a pointer, since
 all of these are wrappers after all.

 As for the added descriptions, I'm not a big fan of the sentence structure
 of:
 > "Calls * filter on file path of template.".

 Semantically, we don't "call filters", we evaluate them, so for the
 description, perhaps something like this might work better:
 > "The template path is filterable via the * hook."

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


More information about the wp-trac mailing list