mirror of
https://github.com/clap-rs/clap
synced 2024-11-14 00:27:13 +00:00
830 B
830 B
Examples
We try to focus our documentation on the four types of documentation. Examples fit into this by providing:
- Cookbook / How-To Guides
- Tutorials (derive, builder)
This directory contains the source for the above.
Contributing
New examples should fit within the above structure and support their narrative
- Add the example to Cargo.toml for any
required-features
- Document how the example works with a
.md
file which will be verified using trycmd - Pull the
.rs
and.md
file into the appropriate module doc comment to be accessible on docs.rs