[wp-trac] [WordPress Trac] #34858: Improve documentation for request_filesystem_credentials()

[WordPress Trac]

#34858: Improve documentation for request_filesystem_credentials()
----------------------------+----------------------------------------
 Reporter:  swissspidy      |      Owner:
     Type:  defect (bug)    |     Status:  new
 Priority:  normal          |  Milestone:  Awaiting Review
Component:  Filesystem API  |    Version:
 Severity:  normal          |   Keywords:  needs-patch good-first-bug
  Focuses:  docs            |
----------------------------+----------------------------------------
 As per the `@todo` comment in `request_filesystem_credentials()`, the
 function's docblock could be improved a lot.

 The params are not aligned correctly and, punctuation could be improved
 and proper descriptions for the optional params are needed.

 See the [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#docblock-formatting PHP documentation
 standards] for more details.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/34858>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform