WP-CLI parameters documentation #2711
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
In addition to the problem outlined in #2702, this PR also changes some commands parameters documentation, so it is clearer to docs readers what is a flag and what is a real parameter. For example, in the index command, the
--setupflag does not accept a value but--per-pageshould always be sent with a value, like--per-page=30.Closes #2702
Verification Process
I've run locally the same command executed by the related GitHub Action.
Changelog Entry
Fixed: WP-CLI parameters documentation.
Credits
Props @felipeelia