The --help messages are not detailed enough #172
Labels
A-docs
Area: documentation for the command and lints
C-enhancement
Category: raise the bar on expectations
Comments
|
Also, is the "check-release" subcommand needed? It seems to be the only subcommand. |
|
Relevant: #86 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe your use case
It is not clear between what cargo-semver-check compares the rustdocs and how it generates them (so it is not clear that the --baseline-version and similar flags are not required). The description of the --package flag doesn't explain that it is useful mainly when dealing with workspaces.
Describe the solution you'd like
The --help messages could explain the use cases of the flags and maybe could briefly explain how cargo-semver-check gets the needed data.
Alternatives, if applicable
No response
Additional Context
No response
The text was updated successfully, but these errors were encountered: