[wp-trac] [WordPress Trac] #36295: Docs: Add phpdocs for WP_Feed_Cache, WP_Feed_Cache_Transient, WP_SimplePie_File, WP_SimplePie_Sanitize_KSES classes

[WordPress Trac]

#36295: Docs: Add phpdocs for WP_Feed_Cache, WP_Feed_Cache_Transient,
WP_SimplePie_File, WP_SimplePie_Sanitize_KSES classes
--------------------------+-----------------------------
 Reporter:  ramiy         |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Future Release
Component:  Feeds         |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+-----------------------------
Changes (by stevenkword):

 * keywords:  has-patch needs-refresh => has-patch


Comment:

 Hi @ramiy,

 I've made a few changes through my update, (attachment:36295.2.diff).
 Here are a few suggestions for upcoming patches.

 * Naming your patch after the ticket it relates to will help other
 contributors to keep track of the many patches they see.
 * When patches are submitted relative to the `/src/` directory, it's a
 good indication that the patch author is aware of unit testing.  In this
 document patch, it's less important, but it's good practice.
 * @access values are only necessary for class methods if the class method
 is private. See [https://make.wordpress.org/core/handbook/best-practices
 /inline-documentation-standards/php/#1-functions-class-methods PHP
 Documentation Standards]
 * @since values can be a little tricky to trace back.  I checked out the
 entire `/tags/` directory from the WordPress SVN and then used ACK to
 search for the first instance of a string.  Something like this:

 {{{
 $ svn co https://core.svn.wordpress.org/tags/ core
 $ cd core
 $ ack -1 "class WP_SimplePie_Sanitize_KSES extends SimplePie_Sanitize"
 3.5/wp-includes/class-feed.php
 105:class WP_SimplePie_Sanitize_KSES extends SimplePie_Sanitize {
 }}}

 In this example, the class was introduced in 3.5.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/36295#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform