[rustc.git] / vendor / clap / examples / README.md

# Examples

We try to focus our documentation on the [four types of
documentation](https://documentation.divio.com/).  Examples fit into this by
providing:
- [Cookbook / How-To Guides](https://docs.rs/clap/latest/clap/_cookbook/index.html)
- Tutorials ([derive](https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html), [builder](https://docs.rs/clap/latest/clap/_tutorial/index.html))

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](../Cargo.toml) for any `required-features`
- Document how the example works with a `.md` file which will be verified using [trycmd](https://docs.rs/trycmd)
- Pull the `.rs` and `.md` file into the appropriate module doc comment to be accessible on docs.rs
Commit	Line	Data
6522a427 EL	1	# Examples
	2
	3	We try to focus our documentation on the [four types of
	4	documentation](https://documentation.divio.com/). Examples fit into this by
	5	providing:
	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
	9	This directory contains the source for the above.
	10
	11	## Contributing
	12
	13	New 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