Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fails to provide sufficient info #157

Open
apb1963 opened this issue Mar 18, 2018 · 4 comments
Open

Documentation fails to provide sufficient info #157

apb1963 opened this issue Mar 18, 2018 · 4 comments

Comments

@apb1963
Copy link

apb1963 commented Mar 18, 2018

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.

@danielbachhuber
Copy link
Member

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?

@bgturner
Copy link

bgturner commented Jan 29, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants
@danielbachhuber @schlessera @bgturner @apb1963 and others