docs: cli usage by Copilot · Pull Request #324 · KSXGitHub/parallel-disk-usage

Copilot · 2026-02-28T09:15:38Z

Fixes #323
Fixes #54

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

github-actions · 2026-02-28T09:30:00Z

Performance Regression Reports

commit: c75e98d

There are no regressions.

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

… refactor test Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

…tertools join, new detection spec Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

… detect boolean flags Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot

Pull request overview

Updates the project’s CLI documentation pipeline by generating USAGE.md and help snapshots directly from clap’s introspection APIs, and adds tests to keep those generated artifacts in sync with the actual CLI.

Changes:

Add usage_md renderer (src/usage_md.rs) and a dedicated pdu-usage-md binary to generate USAGE.md.
Gate/export the new module behind cfg(feature = "cli") to fix doc builds without CLI features.
Add snapshot-style tests and generation script updates for exports/*.help and USAGE.md, and link USAGE.md from the README.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/sync_help.rs	Adds snapshot tests to detect stale `exports/*.help` and `USAGE.md`.
src/usage_md.rs	Implements Markdown rendering for CLI usage/options/examples via clap introspection.
src/lib.rs	Gates and exports `usage_md` behind the `cli` feature.
generate-completions.sh	Extends generator script to also emit long/short help and `USAGE.md`.
exports/short.help	Adds generated short help snapshot.
exports/long.help	Adds generated long help snapshot.
cli/usage_md.rs	Adds `pdu-usage-md` binary entrypoint to print rendered Markdown.
USAGE.md	Adds regenerated CLI usage reference page.
README.md	Links to `USAGE.md` from the README.
Cargo.toml	Registers the new `pdu-usage-md` binary (feature-gated).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-28T19:45:58Z

+//!
+//! If the tests fail, run `./generate-completions.sh` on the root of the repo to update the help files.
+
+// Since the CLI in Windows look a little different, and I am way too lazy to make two versions


Grammar: "the CLI in Windows look" should be "the CLI in Windows looks".

Suggested change

// Since the CLI in Windows look a little different, and I am way too lazy to make two versions

// Since the CLI in Windows looks a little different, and I am way too lazy to make two versions

Initial plan

3b26ddd

Copilot AI assigned Copilot and KSXGitHub Feb 28, 2026

Copilot started work on behalf of KSXGitHub February 28, 2026 09:15 View session

docs: add CLI usage documentation and sync_help tests

b83af13

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add CLI usage documentation and help files~~ docs: add CLI usage help files, README section, and sync tests Feb 28, 2026

Copilot finished work on behalf of KSXGitHub February 28, 2026 09:22

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of KSXGitHub February 28, 2026 09:37 View session

fix: restrict sync_help tests to unix only

d17b9c1

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot finished work on behalf of KSXGitHub February 28, 2026 09:40

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of KSXGitHub February 28, 2026 09:54 View session

feat: parse long.help to generate structured USAGE.md

81b8f0d

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

This comment was marked as resolved.

Sign in to view

Copilot AI changed the title ~~docs: add CLI usage help files, README section, and sync tests~~ docs: add CLI usage help files, README section, USAGE.md, and sync tests Feb 28, 2026

Copilot finished work on behalf of KSXGitHub February 28, 2026 10:10

KSXGitHub requested changes Feb 28, 2026

View reviewed changes

Comment thread tests/sync_help.rs Outdated

Comment thread tests/sync_help.rs Outdated

Comment thread README.md Outdated

Comment thread USAGE.md Outdated

Comment thread USAGE.md Outdated

Comment thread USAGE.md Outdated

Copilot started work on behalf of KSXGitHub February 28, 2026 10:36 View session

refactor: parse flags/aliases/examples properly; fix Clippy warnings;…

18be173

… refactor test Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot finished work on behalf of KSXGitHub February 28, 2026 10:44

KSXGitHub requested changes Feb 28, 2026

View reviewed changes

Comment thread USAGE.md Outdated

Comment thread USAGE.md Outdated

Comment thread USAGE.md Outdated

Comment thread cli/usage_md.rs Outdated

Comment thread cli/usage_md.rs Outdated

Comment thread cli/usage_md.rs Outdated

Copilot started work on behalf of KSXGitHub February 28, 2026 11:33 View session

Copilot finished work on behalf of KSXGitHub February 28, 2026 11:40

Copilot started work on behalf of KSXGitHub February 28, 2026 11:57 View session

Copilot AI and others added 2 commits February 28, 2026 12:04

refactor(usage_md): heading-based options, periods on descriptions, i…

8dce0c9

…tertools join, new detection spec Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

fix: remove redundant .iter() on Vec in render_option_item

b30f626

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot AI changed the title ~~docs: add CLI usage help files, README section, USAGE.md, and sync tests~~ refactor(usage_md): heading-based options, semantic item detection, periods, itertools join Feb 28, 2026

Copilot finished work on behalf of KSXGitHub February 28, 2026 12:08

fix(docs): unnecessary comments

c74bc7f

KSXGitHub requested changes Feb 28, 2026

View reviewed changes

Comment thread src/usage_md.rs

Comment thread src/usage_md.rs

Copilot started work on behalf of KSXGitHub February 28, 2026 18:17 View session

fix: required positional args use angle brackets; use get_action() to…

5fc9f28

… detect boolean flags Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot finished work on behalf of KSXGitHub February 28, 2026 18:25

KSXGitHub added 3 commits March 1, 2026 01:32

refactor: reduce allocation

03ec521

feat(docs): still show default of "true"

d2b6169

refactor: replace the brittle string replacement

c178b5d

KSXGitHub approved these changes Feb 28, 2026

View reviewed changes

KSXGitHub requested a review from Copilot February 28, 2026 18:50

Copilot started reviewing on behalf of KSXGitHub February 28, 2026 18:50 View session

KSXGitHub marked this pull request as ready for review February 28, 2026 18:51

Copilot AI reviewed Feb 28, 2026

View reviewed changes

Comment thread tests/sync_help.rs Outdated

Comment thread exports/long.help

KSXGitHub marked this pull request as draft February 28, 2026 18:58

refactor: remove unused link

32628c6

Copilot started work on behalf of KSXGitHub February 28, 2026 19:16 View session

fix: strip trailing whitespace from help exports and normalize in tests

bf66a60

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Copilot finished work on behalf of KSXGitHub February 28, 2026 19:23

KSXGitHub added 4 commits March 1, 2026 02:28

refactor: use pipe

22fd0af

test: remove unnecessary trimming

38b2369

refactor: use macro

ef37654

refactor: rename a test

b801758

KSXGitHub requested a review from Copilot February 28, 2026 19:42

Copilot started reviewing on behalf of KSXGitHub February 28, 2026 19:43 View session

Copilot AI reviewed Feb 28, 2026

View reviewed changes

KSXGitHub added 2 commits March 1, 2026 02:48

chore(cargo): include USAGE.md

b516907

refactor: split the tests

05e0285

KSXGitHub marked this pull request as ready for review February 28, 2026 19:55

KSXGitHub merged commit 20758ea into master Feb 28, 2026
13 checks passed

KSXGitHub deleted the copilot/add-cli-usage-documentation branch February 28, 2026 20:07

	// Since the CLI in Windows look a little different, and I am way too lazy to make two versions
	// Since the CLI in Windows looks a little different, and I am way too lazy to make two versions

Uh oh!

Conversation

Copilot AI commented Feb 28, 2026 • edited by KSXGitHub Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Feb 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance Regression Reports

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 28, 2026 •

edited by KSXGitHub

Loading

github-actions Bot commented Feb 28, 2026 •

edited

Loading