mirror of https://github.com/clap-rs/clap synced 2024-12-14 14:52:33 +00:00

Ed Page f925ca84b6 docs: Clarify how to use examples

When we restuctured the examples, we lost the notes on how they should
be structured, so this adds it back in.

2022-09-26 21:06:02 -05:00

Examples

We try to focus our documentation on the four types of documentation. Examples fit into this by providing:

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.tom 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