Skip to content

[worker:doc-drift] fix CLI reference drift in check and global flags - #438

Merged
norrietaylor merged 1 commit into
mainfrom
fix/cli-reference-drift-check-global-flags-bc8f95a42016ac16
Jun 17, 2026
Merged

[worker:doc-drift] fix CLI reference drift in check and global flags#438
norrietaylor merged 1 commit into
mainfrom
fix/cli-reference-drift-check-global-flags-bc8f95a42016ac16

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Resolves the documentation drift reported in #388. The CLI reference at docs/reference/cli.md had three command-level drifts against the current implementation in crates/minimal/src/ (verified at commit 01badc92).

What changed

All edits are confined to docs/reference/cli.md:

  1. check flag rename --harnesses -> --stacks. CheckKind in crates/minimal/src/cmd_check.rs declares packages, stacks, profiles (no harnesses), and crates/minimal/src/main.rs describes the command as validating "packages, stacks, and profiles". Updated the flag row, the command description, and the filter-name note to use stack terminology so minimal check --stacks matches reality.
  2. Added the missing --offline global flag row. crates/minimal/src/main.rs defines offline as a global = true flag, but the Global Flags table omitted it.
  3. Corrected the --num-parallel-builds short flag -j -> -n. The field uses #[arg(short, long, global = true)] with no explicit char, so clap derives -n from the field name num_parallel_builds; -j was never registered.

Verification

This is a documentation-only change — no .rs files were touched — so cargo build/clippy/test behavior is unaffected; the cargo build --workspace --all-targets self-check is not applicable to a pure Markdown edit. Each of the three claims was verified against the current target source (cmd_check.rs CheckKind, main.rs offline and num_parallel_builds arg attributes and the Check command doc-comment) before editing. The non-bypassable host backstop still re-runs the full gate (cargo fmt --all --check, cargo build --workspace --all-targets --locked, cargo clippy --workspace --all-targets --locked -- -D warnings, cargo test --workspace --all-targets --locked) before this PR opens.

Closes #388

Generated by Chore-issue worker agent (side-repo-ops operator) · ◷

Summary by CodeRabbit

  • Documentation
    • Added new --offline global flag to CLI reference
    • Changed --num-parallel-builds short option from -j to -n
    • Updated check command documentation to clarify validation scope for packages, stacks, and profiles with corresponding flag adjustments

@gominimal-aw-bot
docs: fix CLI reference drift in check and global flags
0b05e98 
Correct three drifts in docs/reference/cli.md against the current
implementation in crates/minimal/src/:

- check: --harnesses -> --stacks (flag renamed; harness terminology
  replaced with stack in the description and filter note)
- global flags: add the missing --offline row
- --num-parallel-builds: short flag -j -> -n (clap derives -n from
  the field name; -j was never registered)

Closes #388
@coderabbitai

coderabbitai Bot commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Three doc-drift corrections in docs/reference/cli.md: the global flags table gains a missing --offline row and corrects --num-parallel-builds's short option from -j to -n; the check command section replaces all harnesses/--harnesses occurrences with stacks/--stacks.

Changes

CLI Reference Doc Drift Fixes

Layer / File(s) Summary
Global flags table corrections
docs/reference/cli.md		 Adds a new --offline row to the global flags table and corrects the short option for --num-parallel-builds from -j to -n.
check command stacks rename
docs/reference/cli.md		 Replaces harnesses/--harnesses with stacks/--stacks in the command description, the flags table row, and the filter-names sentence.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hop hop, the docs were astray,
-j was a fib, now -n saves the day.
--offline was shy, hiding out of sight,
and harnesses fled — stacks are right!
The reference is true, the rabbit hops bright. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately identifies the main change as fixing CLI reference drift in check and global flags, directly matching the PR objectives.
Linked Issues check ✅ Passed The PR addresses all three requirements from issue #388: renaming --harnesses to --stacks, adding the missing --offline flag row, and correcting --num-parallel-builds short flag from -j to -n.
Out of Scope Changes check ✅ Passed All changes are confined to docs/reference/cli.md and directly address the three documented drifts in issue #388, with no extraneous modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands and usage tips.

@norrietaylor
norrietaylor enabled auto-merge (squash) June 17, 2026 18:59
@norrietaylor
norrietaylor merged commit e518d69 into main Jun 17, 2026
12 checks passed
@norrietaylor
norrietaylor deleted the fix/cli-reference-drift-check-global-flags-bc8f95a42016ac16 branch June 17, 2026 19:02
@gominimal-aw-bot gominimal-aw-bot Bot mentioned this pull request Jul 29, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@twitchyliquid64 twitchyliquid64 twitchyliquid64 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

agent:doc-drift: CLI reference drift in check flags and global flags

2 participants

@twitchyliquid64 @norrietaylor