[wp-trac] [WordPress Trac] #30989: Additional audit for recent documentation changes

[WordPress Trac]

#30989: Additional audit for recent documentation changes
----------------------------+------------------------------
 Reporter:  SergeyBiryukov  |       Owner:
     Type:  defect (bug)    |      Status:  new
 Priority:  normal          |   Milestone:  Awaiting Review
Component:  General         |     Version:  4.1
 Severity:  normal          |  Resolution:
 Keywords:  dev-feedback    |     Focuses:  docs
----------------------------+------------------------------
Description changed by SergeyBiryukov:

Old description:

> Some of the documentation changes in #30224 need an additional audit for
> consistency:
>
> * [30673] added `null` as a possible `@return` value for
> `set_user_setting()` and `delete_user_setting()`, but it's not explained
> in the comment when it can be returned.
> * [30674] removed `int` as a possible `@return` value for
> `get_the_time()`, `get_post_time()`, and `get_post_modified_time()`, but
> they all depend on `mysql2date()` and can return an integer if `'U'` or
> `'G'` is passed. [30682] added `int` back, but only for
> `get_post_time()`.
> * [30678] added `string` as a possible `@return` value for
> `WP_Filesystem_SSH2::chown()`, but it's not explained in the comment when
> it can be returned.

New description:

 Some of the documentation changes in #30224 need an additional audit for
 consistency:

 * [30673] added `null` as a possible `@return` value for
 `set_user_setting()` and `delete_user_setting()`, but it's not explained
 in the comment when it can be returned.
 * [30674] removed `int` as a possible `@return` value for
 `get_the_time()`, `get_post_time()`, and `get_post_modified_time()`, but
 they all depend on `mysql2date()` and can return an integer if `'U'` or
 `'G'` is passed. [30682] added `int` back, but only for `get_post_time()`.
 * [30678] added `string` as a possible `@return` value for
 `WP_Filesystem_SSH2::chown()`, but it's not explained in the comment when
 it can be returned.
 * There are probably more, these are just the ones that stood out to me.

--

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