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

--context option not documented #463

Closed
2 tasks done
siliconforks opened this issue Oct 4, 2023 · 1 comment · Fixed by #466
Closed
2 tasks done

--context option not documented #463

siliconforks opened this issue Oct 4, 2023 · 1 comment · Fixed by #466

Comments

@siliconforks
Copy link
Contributor

Bug Report

Describe the current, buggy behavior

If you run wp help, the "GLOBAL PARAMETERS" section lists a --context=<context> option, but this option is not documented in the "Config" section of the handbook.

Describe how other contributors can replicate this bug

Simply run wp help - every option listed there is documented in the "Config" section of the handbook except for --context.

Describe what you would expect as the correct outcome

I would expect that the list of options in the handbook should match the options listed with wp help. This is already the case for every option except for the --context option.

Possibly there is some reason that the --context option is not documented - perhaps it's considered experimental and subject to change? In that case I still think it would be better just to state that in the documentation instead of leaving it undocumented.

Let us know what environment you are running this on

OS:     Linux 6.2.0-34-generic #34~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Thu Sep  7 13:12:03 UTC 2 x86_64
Shell:  /bin/bash
PHP binary:     /usr/bin/php8.1
PHP version:    8.1.2-1ubuntu2.14
php.ini used:   /etc/php/8.1/cli/php.ini
MySQL binary:   /usr/bin/mysql
MySQL version:  mysql  Ver 8.0.34-0ubuntu0.22.04.1 for Linux on x86_64 ((Ubuntu))
SQL modes:
WP-CLI root dir:        phar://wp-cli.phar/vendor/wp-cli/wp-cli
WP-CLI vendor dir:      phar://wp-cli.phar/vendor
WP_CLI phar path:       /home/u
WP-CLI packages dir:
WP-CLI cache dir:       /home/u/.wp-cli/cache
WP-CLI global config:
WP-CLI project config:
WP-CLI version: 2.8.1

Provide a possible solution

Probably the documentation for --context could be copied from the WP-CLI v2.6.0 Release Notes.

@danielbachhuber
Copy link
Member

Thanks for the suggestion, @siliconforks !

I agree that it would be helpful to document the --context global argument. Feel free to submit a PR, if you'd like.

siliconforks added a commit to siliconforks/handbook that referenced this issue Oct 12, 2023
danielbachhuber pushed a commit that referenced this issue Oct 12, 2023
@danielbachhuber danielbachhuber added this to the 2.9.0 milestone Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment