Name Date Size

..25-Oct-20244 KiB

cargo-example-derive.mdH A D25-Oct-20241 KiB

cargo-example-derive.rsH A D25-Oct-2024466

cargo-example.mdH A D25-Oct-2024961

cargo-example.rsH A D25-Oct-2024659

demo.mdH A D25-Oct-2024444

demo.rsH A D25-Oct-2024445

derive_ref/H25-Oct-20244 KiB

escaped-positional-derive.mdH A D25-Oct-20241.3 KiB

escaped-positional-derive.rsH A D25-Oct-2024692

escaped-positional.mdH A D25-Oct-20241.2 KiB

escaped-positional.rsH A D25-Oct-20241 KiB

find.mdH A D25-Oct-2024832

find.rsH A D25-Oct-20243.2 KiB

git-derive.mdH A D25-Oct-20242.8 KiB

git-derive.rsH A D25-Oct-20244.2 KiB

git.mdH A D25-Oct-20242.5 KiB

git.rsH A D25-Oct-20244.8 KiB

multicall-busybox.mdH A D25-Oct-2024891

multicall-busybox.rsH A D25-Oct-20241.6 KiB

multicall-hostname.mdH A D25-Oct-2024268

multicall-hostname.rsH A D25-Oct-2024654

pacman.mdH A D25-Oct-20241.8 KiB

pacman.rsH A D25-Oct-20244.1 KiB

README.mdH A D25-Oct-2024830

repl.rsH A D25-Oct-20242.5 KiB

tutorial_builder/H25-Oct-20244 KiB

tutorial_derive/H25-Oct-20244 KiB

typed-derive.mdH A D25-Oct-20243.8 KiB

typed-derive.rsH A D25-Oct-20242.9 KiB

README.md

1# Examples
2
3We try to focus our documentation on the [four types of
4documentation](https://documentation.divio.com/).  Examples fit into this by
5providing:
6- [Cookbook / How-To Guides](https://docs.rs/clap/latest/clap/_cookbook/index.html)
7- Tutorials ([derive](https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html), [builder](https://docs.rs/clap/latest/clap/_tutorial/index.html))
8
9This directory contains the source for the above.
10
11## Contributing
12
13New examples should fit within the above structure and support their narrative
14- Add the example to [Cargo.toml](../Cargo.toml) for any `required-features`
15- Document how the example works with a `.md` file which will be verified using [trycmd](https://docs.rs/trycmd)
16- Pull the `.rs` and `.md` file into the appropriate module doc comment to be accessible on docs.rs
17