Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#31267 closed defect (bug) (fixed)

Clean-up documentation for get_filesystem_method()

Reported by: ericlewis's profile ericlewis Owned by: drewapicture's profile DrewAPicture
Milestone: 4.2 Priority: low
Severity: normal Version: 2.5
Component: Filesystem API Keywords: has-patch dev-feedback
Focuses: docs Cc:

Description


Attachments (4)

31267.diff (2.0 KB) - added by ericlewis 9 years ago.
31267.2.patch (2.1 KB) - added by HarishChaudhari 9 years ago.
Updated PHP documentation as suggested by @DrewAPicture
31267.3.patch (2.1 KB) - added by HarishChaudhari 9 years ago.
Updated PHP documentation as suggested by @DrewAPicture, removed unnecessary space
31267.4.diff (2.2 KB) - added by valendesigns 9 years ago.
Patch from root

Download all attachments as: .zip

Change History (10)

@ericlewis
9 years ago

#1 @DrewAPicture
9 years ago

  • Keywords has-patch added
  • Priority changed from normal to low
  • Version changed from trunk to 2.5

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.

#2 @DrewAPicture
9 years ago

  • Keywords needs-patch added; has-patch removed

See comment:1 for feedback on 31267.diff.

@HarishChaudhari
9 years ago

Updated PHP documentation as suggested by @DrewAPicture

@HarishChaudhari
9 years ago

Updated PHP documentation as suggested by @DrewAPicture, removed unnecessary space

#3 @HarishChaudhari
9 years ago

  • Keywords has-patch added; needs-patch removed

I have updated PHP documentation as suggested by @DrewAPicture. Made few tweaks using earlier patch, added link for transports as well.

Let me know if this looks good or any suggestions.

Please consider 31267.3.patch

Version 0, edited 9 years ago by HarishChaudhari (next)

@valendesigns
9 years ago

Patch from root

#4 @valendesigns
9 years ago

  • Keywords dev-feedback added

The previous patch did not apply from the root directory. I've refreshed the patch and fixed some spacing issues in the @param section. Otherwise, everything looks pretty good. I leave it to you @DrewAPicture.

#5 @DrewAPicture
9 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#6 @DrewAPicture
9 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 31884:

Clean up DocBlock information and syntax for get_filesystem_method().

Props ericlewis, HarishChaudhari, valendesigns.
Fixes #31267.

Note: See TracTickets for help on using tickets.