Repository navigation
fix(docs): omit hidden commands from markdown - #1315
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review. 📝 WalkthroughWalkthroughMarkdown spec generation now excludes commands with ChangesMarkdown command visibility
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change omits hidden commands from single-file Markdown references while preserving visible command output, with regression coverage included; no actionable merge-blocking risk remains beyond normal checks and review. Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (1 skipped: 1 unsupported.) Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Instruction counts
No instruction-count regression above 1%. Only instruction counts gate. Wall clock is shown for context — on identical hardware it moves 4-20% run to run. Measured by tak — instruction-counted CLI benchmarks, stored in this repository's git notes. Shadow comparisonParsing
|
Summary
Tests
cargo fmt --all -- --checkcargo test -p usage-lib --all-features hidden_commands_are_omitted_from_single_file_markdowncargo test -p usage-lib --all-features docs::markdown::spec::testsThis pull request was generated by Codex.
Note
Low Risk
Documentation rendering only; behavior aligns hidden subcommands with existing index and flag/arg filtering.
Overview
Single-file Markdown reference generation no longer emits sections for commands marked
hide=#true. Thespec_template.md.terasubcommand loop now uses the samefilter(attribute="hide", value=false)pattern already used on the index and for hidden args/flags.A regression test asserts that a visible command still gets a
##heading while a hiddensetupcommand and its help text never appear inrender_spec()output.Reviewed by Cursor Bugbot for commit 29355b4. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
Documentation
Tests