[wp-trac] [WordPress Trac] #42227: PHPDoc correction for src/wp-admin/includes/class-wp-filesystem-base.php

[WordPress Trac]

#42227: PHPDoc correction for src/wp-admin/includes/class-wp-filesystem-base.php
----------------------------+------------------------------
 Reporter:  Jaydeep Rami    |       Owner:
     Type:  defect (bug)    |      Status:  new
 Priority:  normal          |   Milestone:  Awaiting Review
Component:  Filesystem API  |     Version:  trunk
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+------------------------------
Changes (by SergeyBiryukov):

 * component:  General => Filesystem API


Comment:

 Hi Jaydeep, thanks for the patch!

 The existing docs for these arguments are correct, it's just that default
 values don't match the expected type.

 * `$theme` should either be documented as `string|false`, or the default
 value should be changed to an empty string, here and and in
 `get_theme_root()` as well.
 * `$mode` should be documented as `int|false`, here and in other `class-
 wp-filesystem-*.php` files as well.

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