✨(cli) make the -b/--backend option a CLI sub-command #546
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
SergioSim
force-pushed
the
backends-as-cli-sub-commands
branch
5 times, most recently
from
67f2597
to
33b8fbf
Compare
With the addition of more backends, the usage documentation of the ralph list/read/write and runserver commands became cluttered as we list all available backends with all their options. Thus, to keep the documentation concise, we choose to remove the -b/--backend option and use a backend sub-command instead. This allows us to have dedicated usage documentation for each backend. We also improve backend documentation by parsing method and settings docstrings to construct option help strings.
SergioSim
force-pushed
the
backends-as-cli-sub-commands
branch
from
33b8fbf
to
e09dcf4
Compare
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.
Purpose
With the addition of more backends, the usage documentation of the ralph list/read/write and runserver commands became cluttered as we list all available backends with all their options.
Proposal
To keep the documentation concise, we propose to remove the
-b/--backendoption and use a backend sub-command instead. This allows us to have dedicated usage documentation for each backend. We also improve backend documentation by parsing method and settings docstrings to construct option help strings.