[wp-trac] [WordPress Trac] #15238: XML-RPC class should have better documentation

[WordPress Trac]

#15238: XML-RPC class should have better documentation
-------------------------+--------------------------------------------------
 Reporter:  koke         |       Owner:                 
     Type:  enhancement  |      Status:  new            
 Priority:  normal       |   Milestone:  Awaiting Review
Component:  XML-RPC      |     Version:                 
 Severity:  minor        |    Keywords:                 
-------------------------+--------------------------------------------------
Changes (by josephscott):

 * cc: josephscott (added)


Comment:

 Some of this gets tricky, for instance if we allow for custom post
 statuses, trying to list the valid ones in the comments is going to be
 incomplete at best.  Another challenge is that since most people
 interested in this API are external clients, they are unlikely to read the
 source code.  In some cases they are forbidden from doing so.

 Some of these have already been documented in the codex, and that might be
 a better place for these overall.  The source code comments could link to
 the codex pages for reference.

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