docs: dependency comparison and rust docs expansion - #1193
Conversation
|
Warning Review limit reached
Next review available in: 4 minutes Limit details: You’ve used all 4 included reviews currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches 💡 1⚔️ Resolve merge conflicts 💡
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 |
Add a measured dependency-graph comparison to the migration page: crate counts from cargo tree for clap 4.6.6 with derive against usage-rs with defaults plus completions, with zero non-usage crates linked into the binary and the derive's proc-macro stack shared with every other derive in the ecosystem. Point to it from the installation section. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- new Quickstart page: a small CLI end to end, every output captured from a real build of the shown code - new Config page: the spec's config block, usage-config-build, layered resolution with provenance, setting= flags, and the drift test - performance: add measured argh and bpaf comparisons from the existing gate shadows, and a stripped-binary size table for all four - args-and-flags: split the 50-row attribute table into grouped tables, drop the duplicate env row - index: crate table gains the config crates, next-steps list gains the missing pages, limitations list gains Elvish and help_template - testing: note that completion assertions have no clap equivalent - dispatch: define the root struct the first example uses - sidebar: add Quickstart and Config, align the help page title Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
347c833 to
1232f79
Compare
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
Started as the missing dependency-footprint comparison; grew into a sweep of the Rust framework docs.
Selling the comparison
validationcaveat stated.New page
/rust/quickstart): a small CLI end to end — declare, run, complete, generate docs. Every output on the page captured from a real build of the shown code, including the passing test.Fixes
envrow removed; the 50-row attribute table split into grouped tables (naming, values, env/defaults, parsing, relationships, deprecation, presentation, completion);setting =row links to the Settings pageusage-config, features table gainsconfig, next-steps gains Quickstart/Settings/Testing/Performance, limitations gains Elvish andhelp_templateRebased on #1180 (
usage::Configderive): an earlier revision of this PR added a/rust/configpage documenting theusage-config-buildpath; that path and crate were removed by #1180 in favor of the derive and its/rust/settingspage, so this PR now links to that page instead.Measured numbers are pinned to clap 4.6.6 (the version the compatibility page audits) and one run of
tasks/perf-shadow.sh.This PR was generated by Claude Code.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with no runtime, API, or security impact.
Overview
Expands the Rust framework docs with a Quickstart that walks a small CLI from declaration through run, completions, generated docs, and a parse test.
Adds clap vs usage dependency-footprint numbers (0 third-party crates in the binary) and argh/bpaf parse-cost and stripped-binary tables, with the caveat that argh’s cheaper numbers come from a much smaller grammar.
Splits the args-and-flags attribute dump into grouped tables, documents
usage-config/ theconfigfeature, retitles Help, and fills small holes (dispatch example root struct, Elvish/help_templatelimitations, completion-testing vs clap).Reviewed by Cursor Bugbot for commit 1232f79. Bugbot is set up for automated code reviews on this repo. Configure here.