• Home
Name
Date
Size
#Lines
LOC

..--

derive_ref/12-May-2024-471386

tutorial_builder/12-May-2024-1,149852

tutorial_derive/12-May-2024-1,100774

README.mdD12-May-2024830 1712

cargo-example-derive.mdD12-May-20241 KiB3928

cargo-example-derive.rsD12-May-2024449 2117

cargo-example.mdD12-May-2024961 3928

cargo-example.rsD12-May-2024659 1918

demo.mdD12-May-2024444 1813

demo.rsD12-May-2024445 2315

escaped-positional-derive.mdD12-May-20241.3 KiB6144

escaped-positional-derive.rsD12-May-2024692 2617

escaped-positional.mdD12-May-20241.2 KiB6144

escaped-positional.rsD12-May-20241 KiB3322

find.mdD12-May-2024832 4637

find.rsD12-May-20243.2 KiB10089

git-derive.mdD12-May-20242.8 KiB160113

git-derive.rsD12-May-20244.1 KiB165143

git.mdD12-May-20242.5 KiB158112

git.rsD12-May-20244.8 KiB138129

multicall-busybox.mdD12-May-2024891 4030

multicall-busybox.rsD12-May-20241.6 KiB4843

multicall-hostname.mdD12-May-2024268 117

multicall-hostname.rsD12-May-2024654 1815

pacman.mdD12-May-20241.8 KiB8056

pacman.rsD12-May-20244.2 KiB112101

repl.rsD12-May-20242.5 KiB9381

typed-derive.mdD12-May-20243.8 KiB13294

typed-derive.rsD12-May-20242.9 KiB10382

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