Skip to content

[worker:doc-drift] drop phantom hook column from loadout list example - #1238

Merged
norrietaylor merged 1 commit into
mainfrom
chore/doc-drift-loadouts-hook-column-dab63bae83be8ad5
Aug 18, 2026
Merged

[worker:doc-drift] drop phantom hook column from loadout list example#1238
norrietaylor merged 1 commit into
mainfrom
chore/doc-drift-loadouts-hook-column-dab63bae83be8ad5

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Issue

Resolves gominimal/minimal#1231 (agent:doc-drift, priority:should-have).

The docs/concepts/loadouts.md page documented the min loadout list output with a / N hook segment in the CONTRIBUTES column, but the CLI never emits a hook count. The column is built as exactly {} pkg / {} var / {} patch -- no hook segment, and no other code path appends one.

Ground truth

crates/minimal/src/loadouts.rs:580-585 (LoadoutRow::from_entry) and :598-603 (LoadoutRow::builtin_default) build the counts as:

counts: format!(
    "{} pkg / {} var / {} patch",
    loadout.packages().len(),
    loadout.vars().len() + loadout.vars_lenient().len(),
    loadout.patches().iter().count(),
),

The sibling reference doc docs/reference/loadouts.md already renders the column correctly, so this drift was limited to the concepts page.

Fix

Edit the example output block in docs/concepts/loadouts.md (the "Listing your loadouts" section) to drop the / N hook segment from each row so it reads N pkg / N var / N patch, matching the code. Also correct the dev row's var count to 1 to match the single [vars] entry (EDITOR = "hx") in the example loadout earlier on the page. Documentation-only change; no source touched.

Verification

This is a Markdown-only change (docs/concepts/loadouts.md); no .rs file was modified, so the build, clippy, and tests are unaffected. The non-bypassable host backstop still gates cargo fmt --all --check, cargo build --workspace --all-targets --locked, cargo clippy --workspace --all-targets --locked -- -D warnings, and cargo test --workspace --all-targets --locked before this PR opens.

Closes #1231

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

Summary by CodeRabbit

  • Documentation
    • Updated the loadout listing example to report package, variable, and patch counts.
    • Removed lifecycle-hook counts from the sample entries.

The min loadout list CONTRIBUTES column is built as
"{} pkg / {} var / {} patch" (crates/minimal/src/loadouts.rs:580-585,
598-603); there is no hook segment. Remove the /N hook column from the
docs/concepts/loadouts.md example output so it matches the CLI, and
correct the dev row's var count to 1 to match the single [vars] entry
(EDITOR = "hx") in the example loadout.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@gominimal-aw-bot
gominimal-aw-bot Bot requested a review from a team as a code owner August 17, 2026 23:31
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ced96499-9f8a-4e27-8ae7-8bcf6e6d28ac

📥 Commits

Reviewing files that changed from the base of the PR and between 4e371c3 and e739cdb.

📒 Files selected for processing (1)
  • docs/concepts/loadouts.md

Included review availability: 4 reviews are currently available. Based on recent review activity, included reviews refill at 5 per hour.


📝 Walkthrough

Walkthrough

The loadout listing documentation example now reports package, variable, and patch counts without lifecycle-hook counts.

Changes

Loadout documentation

Layer / File(s) Summary
Update loadout listing example
docs/concepts/loadouts.md
The sample min loadout list output omits lifecycle-hook contribution counts from both entries.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to e739c

This localized documentation update corrects the loadout example to match the CLI output, with no source or runtime behavior changes. No actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: evanspearman

Poem

I’m a rabbit with a tidy chart,
Trimming hook counts from the start.
Packages, variables, patches stay,
Clearer numbers lead the way.
Hop, hop—docs are neat today!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the documentation change and the removal of the phantom hook column.
Description check ✅ Passed The description explains the issue, fix, ground truth, and verification, but it omits the template's Summary, Testing, and Checklist headings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/doc-drift-loadouts-hook-column-dab63bae83be8ad5

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

@norrietaylor
norrietaylor merged commit f3a42fe into main Aug 18, 2026
33 checks passed
@norrietaylor
norrietaylor deleted the chore/doc-drift-loadouts-hook-column-dab63bae83be8ad5 branch August 18, 2026 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

agent:doc-drift: concepts/loadouts.md shows a phantom "hook" column in min loadout list output

1 participant