docs: fix doctor command section — missing per-action output and flag descriptions#15
docs: fix doctor command section — missing per-action output and flag descriptions#15
Conversation
…ag behaviors Agent-Logs-Url: https://github.com/satococoa/git-worktreeinclude/sessions/5fd00c64-2634-47da-99ff-bd26ddb8264a Co-authored-by: satococoa <31448+satococoa@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the README’s doctor command documentation to reflect its actual human-readable output and to document --quiet/--verbose behavior differences vs apply.
Changes:
- Documented
doctorflags--quietand--verbose, including--quiet’s narrower suppression scope. - Expanded the
doctor“Shows:” list to include per-action output (and its suppression under--quiet).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `--from`: same as `apply` | ||
| - `--include`: same as `apply` | ||
| - `--quiet`: suppress per-action output (target root, source, include status, and summary are always shown) | ||
| - `--verbose`: print "no matched files" message when no files are matched |
There was a problem hiding this comment.
The quoted message for doctor --verbose doesn’t match the actual output. The CLI prints No matched ignored files. (capitalized, with period), not "no matched files". Consider updating this description to match the exact message or rephrase without quoting a specific string.
| - `--verbose`: print "no matched files" message when no files are matched | |
| - `--verbose`: print an additional message when no ignored files are matched |
| - `--quiet`: suppress per-action output (target root, source, include status, and summary are always shown) | ||
| - `--verbose`: print "no matched files" message when no files are matched |
There was a problem hiding this comment.
doctor rejects using --quiet and --verbose together (usage error), but this isn’t mentioned in the flag descriptions. Since this section now documents both flags, it would be helpful to add a short note that they are mutually exclusive.
| - `--quiet`: suppress per-action output (target root, source, include status, and summary are always shown) | |
| - `--verbose`: print "no matched files" message when no files are matched | |
| - `--quiet`: suppress per-action output (target root, source, include status, and summary are always shown); mutually exclusive with `--verbose` | |
| - `--verbose`: print "no matched files" message when no files are matched; mutually exclusive with `--quiet` |
The
doctorcommand section in the README omitted per-action output from its "Shows:" list and left--quiet/--verboseundescribed, despite those flags behaving differently from theirapplycounterparts.What was wrong
doctorprints per-action lines by default (same format asapply), but the "Shows:" list didn't include them.--quietdivergence undocumented:apply --quietsuppresses all human-readable output;doctor --quietonly suppresses per-action lines — TARGET, SOURCE, INCLUDE, and SUMMARY are always printed.--verboseundescribed: fordoctor,--verbosesurfaces a "no matched files" message when no files match (unlikeapplywhere--verboseadds the include status line and ensures the SUMMARY is shown even on no-op).Changes
--quietand--verboseflag descriptions to thedoctorsection, clarifying the narrower scope of--quiet.--quietsuppression note) to the "Shows:" bullet list.