Improve documentation of bundle doctor, bundle plugin, and bundle config
#8919
Conversation
This file contains hidden or 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
For synopsis, subcommand and flag documentation like other commands do.
Name default value placeholders in a more standard way. That's what our specs check, but they don't yet work for subcommand flags.
Make synopsis, subcommands, and CLI flags use a format consistent with the other docs, and also reword some sentences for clarify.
We had them duplicated, but with slightly different features: * The ones in `other/cli_man_pages.rb` enforced a specific structure to document CLI options, so were less likely to have false positives. * The ones in `quality_spec.rb` were able to check subcommands and their flags. This commit merges both and preserves the best of both.
deivid-rodriguez
changed the title
bundle doctor, bundle plugin, and bundle config
deivid-rodriguez
deleted the
deivid-rodriguez/improve-cli-documentation
branch
deivid-rodriguez
added a commit
that referenced
this pull request
Sep 4, 2025
…ocumentation Improve documentation of `bundle doctor`, `bundle plugin`, and `bundle config` (cherry picked from commit 9934845)
deivid-rodriguez
added a commit
that referenced
this pull request
Sep 9, 2025
…ocumentation Improve documentation of `bundle doctor`, `bundle plugin`, and `bundle config` (cherry picked from commit 9934845)
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.
What was the end-user or developer problem that led to this PR?
We had two duplicated specs checking essentially the same thing: that all subcommands and their flags are documented.
What is your fix for the problem, implemented in this PR?
This PR merges the specs to keep the best of each, and make sure all our commands pass them, resulting in more standard documentation for commands with subcommands (
bundle config,bundle plugin, andbundle doctor).Make sure the following tasks are checked