docs: add clap compatibility matrix - #1030
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
aceb494 to
31d28c0
Compare
Instruction countsNothing was compared, and so nothing was gated. No series appears on both sides: either the base has no measurements recorded, or the two were measured on different runner classes, which are deliberately not comparable — counts shift between machine types by more than a real regression does. New, nothing to compare against: 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
|
31d28c0 to
bc9e979
Compare
bc9e979 to
15e6d90
Compare
15e6d90 to
721a9b1
Compare
721a9b1 to
07f13d7
Compare
07f13d7 to
6296f88
Compare
Summary
Why
A clap user needs to know whether behavior survives before changing parsers. The existing plan audits gaps, but it is not presented as a migration-facing, versioned reference and does not clearly separate usage-native support from bridge loss.
This establishes the first public baseline. It intentionally does not close the plan item yet: an exhaustive inventory of every forwarded builder method still remains.
Validation
git diff --checkprettier --check docs/rust/clap-compatibility.md docs/rust/index.md docs/spec/integrations/clap.mdThis PR is stacked on #1027.
This pull request was generated by Codex.
Note
Low Risk
Documentation-only; no runtime, parser, or bridge code changes.
Overview
Adds a versioned clap compatibility matrix (
clap4.6.6 /clap_derive4.6.4) at/rust/clap-compatibility, aimed at migration andclap_usagebridge expectations.The page defines status labels (Supported, Usage only, Partial, Different, Unsupported, Non-goal) and tables for derives/types, arguments, relationships/routing, and help/generated artifacts. It separates native
usagedeclarations fromclap::Command→ spec fidelity and calls out bridge losses (e.g. setter-only clap APIs) and usage-only extensions.Rust docs and clap integration pages now link to the matrix from “Where to go next” and “Links”.
Reviewed by Cursor Bugbot for commit 6296f88. Bugbot is set up for automated code reviews on this repo. Configure here.