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

[WordPress Trac]

#30989: Additional audit for recent documentation changes
----------------------------+---------------------------
 Reporter:  SergeyBiryukov  |       Owner:  DrewAPicture
     Type:  task (blessed)  |      Status:  accepted
 Priority:  normal          |   Milestone:  4.6
Component:  General         |     Version:  4.1
 Severity:  normal          |  Resolution:
 Keywords:  dev-feedback    |     Focuses:  docs
----------------------------+---------------------------

Comment (by DrewAPicture):

 Replying to [comment:16 dd32]:
 > Replying to [comment:14 DrewAPicture]:
 > > Have asked @dd32 if he could please give feedback on
 [attachment:30989.diff] which attempts return descriptions for
 `WP_Filesystem_SSH2::chown()` and `WP_Filesystem_SSH2::run_command()`.
 >
 > Seems sane. I'm not sure when `chown()` returns a a string though, I
 doubt it'd return anything on a success, it'd more likely be a failure..
 but I can't test it.

 You're correct. In re-reading the source for `->chown()`, the second
 parameter, `$returnbool` is always specified as true. Thus,
 `->run_command()` can only return a boolean. On the other hand,
 `->run_command()` could return a string in the case where `$returnbool`
 was `false` and the `stream_get_contents()` call returned something (was
 successful).

 I'll fix it on commit.

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