From 6261a0b439336c19f0de98af8fe04c6bbba9def4 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 21 Apr 2016 02:37:36 +0000 Subject: [PATCH] Docs: Add missing return descriptions for `WP_Filesystem_SSH2::chown()` and `WP_Filesystem_SSH2::run_command()`. Fixes #30989. git-svn-id: https://develop.svn.wordpress.org/trunk@37270 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-filesystem-ssh2.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/wp-admin/includes/class-wp-filesystem-ssh2.php b/src/wp-admin/includes/class-wp-filesystem-ssh2.php index 70f81d056f..158b55598c 100644 --- a/src/wp-admin/includes/class-wp-filesystem-ssh2.php +++ b/src/wp-admin/includes/class-wp-filesystem-ssh2.php @@ -193,7 +193,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base { * * @param string $command * @param bool $returnbool - * @return bool|string + * @return bool|string True on success, false on failure. String if the command was executed, `$returnbool` + * is false (default), and data from the resulting stream was retrieved. */ public function run_command( $command, $returnbool = false ) { if ( ! $this->link ) @@ -330,10 +331,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base { * * @access public * - * @param string $file Path to the file. - * @param string|int $owner A user name or number. - * @param bool $recursive Optional. If set True changes file owner recursivly. Defaults to False. - * @return bool|string Returns true on success or false on failure. + * @param string $file Path to the file. + * @param string|int $owner A user name or number. + * @param bool $recursive Optional. If set True changes file owner recursivly. Default False. + * @return bool True on success or false on failure. */ public function chown( $file, $owner, $recursive = false ) { if ( ! $this->exists($file) )