[wp-trac] [WordPress Trac] #31267: Clean-up documentation for get_filesystem_method()

[WordPress Trac]

#31267: Clean-up documentation for get_filesystem_method()
----------------------------+-------------------
 Reporter:  ericlewis       |       Owner:
     Type:  defect (bug)    |      Status:  new
 Priority:  low             |   Milestone:  4.2
Component:  Filesystem API  |     Version:  2.5
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs
----------------------------+-------------------
Changes (by DrewAPicture):

 * keywords:   => has-patch
 * priority:  normal => low
 * version:  trunk => 2.5


Comment:

 Hi, thanks for the patch. Some feedback:

 * The list in the summary should use "or" instead of "and", e.g. "reading,
 writing, modifying, or deleting"
 * The "valid values for these ..." sentence should be moved up follow the
 sentence describing the various transports, otherwise, "these" doesn't
 making any sense in that context.
 * All three parameters are optionsl so they should be marked as such in
 the `@param` descriptions, along with listing accepted values and defaults
 for each. With that done, we can remove the `@todo` line in the DocBlock.

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