[wp-trac] [WordPress Trac] #42227: PHPDoc correction for src/wp-admin/includes/class-wp-filesystem-base.php
WordPress Trac
noreply at wordpress.org
Sun Oct 15 12:48:54 UTC 2017
#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
----------------------------+------------------------------
Comment (by Jaydeep Rami):
Replying to [comment:1 SergeyBiryukov]: Thank you @SergeyBiryukov, I
understood. Thanks for the explanation!
> 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:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list