[wp-trac] Re: [WordPress Trac] #8799: get_search_form() is inadequately documented

WordPress Trac wp-trac at lists.automattic.com
Mon Jan 5 06:49:11 GMT 2009


#8799: get_search_form() is inadequately documented
----------------------------------------------+-----------------------------
 Reporter:  sampablokuper                     |        Owner:         
     Type:  enhancement                       |       Status:  closed 
 Priority:  normal                            |    Milestone:  2.8    
Component:  WordPress.org                     |      Version:  2.7    
 Severity:  normal                            |   Resolution:  wontfix
 Keywords:  search theme documentation codex  |  
----------------------------------------------+-----------------------------
Comment (by DD32):

 sampablokuper: Is it a Documentation error on the Codex, Or a bug within
 the Core WordPress Code?

 Bugs in the core code belong on Trac (Or Documentation errors in the
 actual Inline documentation in the PHP), Codex documentation issues do
 not, Change it yourself, Go to the support forums or post on the
 [http://lists.automattic.com/mailman/listinfo/wp-docs documentation
 mailing list]

 If you do not understand the API, Post in the support forums and ask for
 help, Do not assume just because the codex doesnt say it, that its a bug,
 You not understanding how the API works is not a bug, It simply means you
 need to learn a bit more, You cannot expect every page to spell it out in
 baby steps, Theres a higher-level overview of actions and filters, Anyone
 who has some PHP knowledge *should* be able to pick it up by following the
 examples. There is no reason why the codex should hold peoples hands
 through -every- little detail

 The groups of people who work on the Code, and those who work on the Codex
 are 2 completely separate groups of people, Very few of either are payed
 to do that, and as such, Most people will not communicate between each
 other, Those doing Documentation work follow the WordPress development,
 and update the codex if need be, If a Developer comes across a Codex page
 thats severely out of date, they may fix it themselves, or post a message
 to someone else on the before mentioned locations to get it fixed up.
 (This is not to say that there are not developers who do both developing
 and documentation, Nor that there is -no- communication, I've had people
 who write documentation contact me numerous times asking for some info on
 a item so they could document it well on the codex)

 Also, Please don't get into re-open wars, If its closed, Someone has
 closed it '''for a reason''', Core developers follow the trac mailing
 list, If they see something thats been closed incorrectly, they will re-
 open and address the issue, As it is, this is NOT a Trac issue.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/8799#comment:11>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software


More information about the wp-trac mailing list