WordPress.org
Get WordPress

Make WordPress Core

Opened 9 years ago

Closed 3 years ago

#41560 closed enhancement (invalid)

WP_Filesystem_FTPext class documentation updates

Reported by: upadalavipul Owned by:
Priority: normal Milestone:
Component: Filesystem API Version:
Severity: normal Keywords:
Cc: Focuses: docs

Description

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

Attachments (2)

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

Download all attachments as: .zip

Change History (6)

@upadalavipul
9 years ago

@ayeshrajans
9 years ago

#1 @ayeshrajans
9 years ago

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

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

#2 @ayeshrajans
9 years ago

  • Summary needs documents improvement → WP_Filesystem_FTPext class documentation updates

#3 @swissspidy
9 years ago

  • Component General → Filesystem API
  • Keywords needs-patch added
  • Type defect (bug) → 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/

#4 @costdev
3 years ago

  • Keywords needs-patch removed
  • Milestone Awaiting Review
  • Resolution → invalid
  • Status new → closed

This was fixed in [45226]. Closing this ticket as now invalid.

Note: See TracTickets for help on using tickets.