Opened 5 years ago

Last modified 5 years ago

#4440 new defect (bug)

missing content from class-level DocBlock of WP_Filesystem_SSH2

Reported by: pbiron's profile pbiron Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords:


In the Code Reference for 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.

Change History (1)

#1 @dd32
5 years ago

I believe this is happening as the parser aborts the description once it hits the `@ contrib ...` line, assuming that the description has ended.

Last edited 5 years ago by dd32 (previous) (diff)
Note: See TracTickets for help on using tickets.