WordPress.org

Make WordPress Core

Opened 2 years ago

Last modified 2 years ago

#41560 new enhancement

WP_Filesystem_FTPext class documentation updates

Reported by: upadalavipul Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version:
Component: Filesystem API Keywords: needs-patch
Focuses: docs Cc:
PR Number:

Description

the function in parameter $time and $atime is define but documentation in Not define

Attachments (2)

41560.patch (466 bytes) - added by upadalavipul 2 years ago.
41560.2.patch (25.3 KB) - added by ayeshrajans 2 years ago.

Download all attachments as: .zip

Change History (5)

@upadalavipul
2 years ago

@ayeshrajans
2 years ago

#1 @ayeshrajans
2 years ago

Attached a patch with the entire class cleaned up and phpdoc fixed; bigger guns:) https://youtu.be/yycyKndEWcA?t=52s

Last edited 2 years ago by ayeshrajans (previous) (diff)

#2 @ayeshrajans
2 years ago

  • Summary changed from needs documents improvement to WP_Filesystem_FTPext class documentation updates

#3 @swissspidy
2 years ago

  • Component changed from General to Filesystem API
  • Keywords needs-patch added
  • Type changed from defect (bug) to enhancement

We have #41057 to update the entire codebase according to our PHP coding standards.

Cleaning up a single file without any tests or anything is quite dangerous. I'd leave that to this ticket and only focus on inline documentation here (like the title suggests). Otherwise it's really hard to review such an enormous patch.

@upadalavipul Note that in your patch the indentation is wrong (spaces vs. tabs) and there's no parameter description.

Please consult the PHP documentation standards: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/

Note: See TracTickets for help on using tickets.