To promote similarity and consistency between WP-CLIWP-CLIWP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/https://make.wordpress.org/cli/ commands, we’ve produced these documentation standards we’d encourage you to follow. Commonality is a key component of usability, because it reduces the mental overhead required when switching between commands.
Pull requests against the WP-CLI project are reviewed for these standards. Please follow these standards for your custom commands as well.
Exception: When message starts with a special key and is wrapped with quotes. Eg – 'movie' is not a registered post type.
If single line message, it must end with ..
Exception: There should be no trailing character in the end when colon : is used like this. Invalid ID: 123
Exception: Message to display in progress bar can omit trailing period. Eg – Generating comments
Filenames and folder names must be wrapped with quotes ( ' ).
Roles, sidebarSidebarA sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. ID, post type key, taxonomyTaxonomyA taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. key must be wrapped with quotes.
Message in the context of ongoing action could end with .... Eg – `Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar…`