docs(shopping-list): document --pantry, --aisle and related flags#354
Conversation
The --pantry flag (added in #340, shipped in 0.30.0) had only a terse one-line help entry, which made it hard to discover and understand — the complaint raised in #333. Expand the help for --aisle, --pantry, --ignore-pantry and --ignore-references to describe what each does and note the config auto-discovery behaviour, matching the detailed style of the other shopping-list options. Refs #333
Review — docs(shopping-list): document --pantry, --aisle and related flagsSummary: Documentation-only PR; no behaviour changes. Overall this is solid and clearly addresses the discoverability gap raised in #333. What's good
Minor suggestions
These are all nits — the PR is ready to merge as-is. |
Summary
Fleshes out the terse help text for
cook shopping-list's--pantry,--aisle,--ignore-pantryand--ignore-referencesflags so they match the detailed, example-rich style of the other options.Context
In #333 a user couldn't find/use
--pantry. The flag itself was added in #340 (shipped in 0.30.0); the reporter was on 0.29.1. But the issue also flagged that the option was poorly documented in--help. Each of these flags previously had only a one-line entry — this expands them to explain behaviour and the config auto-discovery (./config/then global config dir).No behavioural change; documentation only.
Verification
cargo build,cargo fmt,cargo clippyall cleancook shopping-list --helprenders the expanded entriesRefs #333