cargo-semver-checks icon indicating copy to clipboard operation
cargo-semver-checks copied to clipboard

Published 20 hours ago • verified publisher icon obi1kenobi

The --help messages are not detailed enough

Open tonowak opened this issue 2 years ago • 2 comments

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

tonowak avatar Nov 06 '22 23:11 tonowak

Also, is the "check-release" subcommand needed? It seems to be the only subcommand.

tonowak avatar Nov 06 '22 23:11 tonowak

Relevant: https://github.com/obi1kenobi/cargo-semver-checks/issues/86#issuecomment-1374871862

tonowak avatar Jan 08 '23 16:01 tonowak