Automattic / Co-Authors-Plus

Multiple bylines and Guest Authors for WordPress
https://wordpress.org/plugins/co-authors-plus/
GNU General Public License v2.0
292 stars 206 forks source link

Improve documentation for WP-CLI commands #596

Open GaryJones opened 6 years ago

GaryJones commented 6 years ago

The WP-CLI commands for Co-Authors Plus are not particularly expressive for WP-CLI users.

Compare any of the DocBlocks against the WP-CLI Documentation Standards, and it's clear that more could be done:

The commands class has no documentation at all, let alone the suggested class annotation.

Extra reference: https://make.wordpress.org/cli/handbook/commands-cookbook/#annotating-with-phpdoc

smistephen commented 6 years ago

This documentation can also include unintuitive function behaviour, such as "the assign-coauthors command does not currently allow for multiple coauthors to be assigned".