Fix help text issues across cmd/desync subcommands#332
Merged
Conversation
- mount-index: replace non-existent `-x` in example with `--cor-file`
- extract: correct `-seed`/`-seed-dir` to `--seed`/`--seed-dir` in description
- inspect-chunks, info: align second example line indent with first
- chunk-server, index-server: rename `--writeable` flag to `--writable`,
keep `--writeable` as a deprecated alias for backward compatibility
- inspect-chunks: rename `newinspectChunksCommand` to `newInspectChunksCommand`
- root: drop trailing period from Short for consistency
- untar: add missing article in Short ("Extract a directory tree ...")
- cache: fix awkward `index(s)` in --ignore flag help
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Cleanup pass over the
Short/Long/Examplefields of the cobra subcommands undercmd/desync/. Most are doc-only; the--writableflag rename is backward compatible.-xfor--cor-file, but no short flag is registered — running the example verbatim errored out. Updated the example to use--cor-file.-seedand-seed-dir(single dash) for long-only flags; corrected to--seed/--seed-dir.Examplewas flush-left instead of matching the two-space indent of the first line, producing ragged--helpoutput. Aligned them.--writeableto the standard spelling--writable. Kept--writeableregistered and marked deprecated via pflag so existing scripts continue to work (with a deprecation warning).newinspectChunksCommand→newInspectChunksCommandto match thenew<Cmd>Commandconvention used everywhere else in the package (callers inmain.goand the test file updated).Short— it was the only one in the package that had one.tar's "Store a directory tree ...").--ignoreflag help saidindex(s); changed toindexes.