[wp-trac] Re: [WordPress Trac] #5233: update.php documentation

[WordPress Trac]

#5233: update.php documentation
--------------------------------------------+-------------------------------
 Reporter:  darkdragon                      |        Owner:  anonymous
     Type:  enhancement                     |       Status:  new      
 Priority:  normal                          |    Milestone:  2.4      
Component:  Optimization                    |      Version:  2.4      
 Severity:  normal                          |   Resolution:           
 Keywords:  phpdoc documentation has-patch  |  
--------------------------------------------+-------------------------------
Comment (by westi):

 I think that the documentation in the code should describe the purpose of
 the function and it's arguments and returns to enable it to be called.

 Any extra information like how to disable a feature should not be in the
 documentation.

 That kind of information is better stored in the codex.

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