[wp-meta] [Making WordPress.org] #4440: missing content from class-level DocBlock of WP_Filesystem_SSH2

[Making WordPress.org]

#4440: missing content from class-level DocBlock of WP_Filesystem_SSH2
---------------------------+--------------------
 Reporter:  pbiron         |      Owner:  (none)
     Type:  defect         |     Status:  new
 Priority:  normal         |  Milestone:
Component:  Developer Hub  |   Keywords:
---------------------------+--------------------
 In the Code Reference for
 [[https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/|WP_Filesystem_SSH2]]
 the Description section says only:

   To use this class you must follow these steps for PHP 5.2.6+

 But in the source, there is a bunch of other content in the DocBlock
 (about how to install the PHP ssh2 extension).

 I'm not sure if that addition content has been manually removed from the
 Code Reference or whether the way the DocBlock is written confuses
 `phpdoc-parser`.

 Since `WP_Filesystem_SSH2::__construct()` has a check that
 `extension_loaded( 'ssh2' )`, I don't think the instructions for how to
 install the extension need to be in the DocBlock, and it could be changed
 to simply say:

   To use this class you, the ssh2 PHP extension must be loaded.

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/4440>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org