entity-command icon indicating copy to clipboard operation
entity-command copied to clipboard

Documentation fails to provide sufficient info

Open apb1963 opened this issue 7 years ago • 4 comments

https://developer.wordpress.org/cli/commands/option/update/

Where is the list of available options and what they do? If it's elsewhere, at the very very least there should be a pointer to it.

wp help option update suffers from the same issue.

apb1963 avatar Mar 18 '18 23:03 apb1963

Good suggestion, @apb1963.

Here's a reference point we could link to: https://codex.wordpress.org/Option_Reference Want to submit a pull request for it?

danielbachhuber avatar Mar 20 '18 12:03 danielbachhuber

It seems like there should be two parts to this:

  1. Empower the user to see what keys exist for an existing site (so link to wp option list documentation)
  2. Link to an external reference of common options within core

The open pull request seems to do the first item, but it probably needs to be placed in a different location than the examples section.

Looking over the handbook source code, I'm not seeing many examples of linking between commands -- is that frowned upon?

I can create a pull request, but wanted to gauge if this was the right track:

(create a section before the ### EXAMPLES block)

### AVAILABLE KEYS

Available keys for the current site can be found by using the [wp option list](https://developer.wordpress.org/cli/commands/option/list/) command.

For a reference to options that come with WordPress core, see the [Option Reference](https://codex.wordpress.org/Option_Reference) page of the WordPress Codex.

bgturner avatar Jan 29 '21 17:01 bgturner