Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-15 07:12:32 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/clap_derive/CONTRIBUTING.md

961 B
Raw Blame History

How to Contribute

See the clap-wide CONTRIBUTING.md. This will contain clap_derive specific notes.

Derive Gotchas

  • Always prefix generated variables with __clap_ to minimize clashes with the user's variables, see #2934.
  • Prefer the path clap over ::clap to allow users to re-export clap, see #2258.
  • Prefer substituting variable names to avoid problems with macro_rules, see #2823.
  • Prefer ::std::result::Result and ::std::option::Option, see #3092.
  • Put whitespace between #quoted #variables.
  • New "magic" attributes must be documented in the derive reference
    • If there is no related builder method, a #![doc(alias = "")] should also be added, see #4984