Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-12 23:57:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/examples
History
Ed Page dde22e74ca style: Update for latest clippy
2022-12-22 12:25:33 -06:00
..
derive_ref fix(error): Don't suggest '--' when it doesn't help 2022-10-13 10:17:11 -05:00
tutorial_builder docs: Provide a better example for positional arg append 2022-10-14 12:54:38 +01:00
tutorial_derive docs: Provide a better example for positional arg append under derive 2022-10-14 14:49:39 +01:00
cargo-example-derive.md fix(help): Make output more dense 2022-09-07 17:13:55 -05:00
cargo-example-derive.rs docs(derive): Update for new attributes 2022-09-02 15:39:13 -05:00
cargo-example.md fix(help): Make output more dense 2022-09-07 17:13:55 -05:00
cargo-example.rs fix: Make arg!(--flag <value>) optional by default 2022-09-12 17:10:01 -05:00
demo.md fix(help): Make output more dense 2022-09-07 17:13:55 -05:00
demo.rs docs(derive): Update for new attributes 2022-09-02 15:39:13 -05:00
escaped-positional-derive.md fix(parser): Quote the suggested help 2022-09-15 16:24:59 -05:00
escaped-positional-derive.rs docs(derive): Update for new attributes 2022-09-02 15:39:13 -05:00
escaped-positional.md fix(parser): Quote the suggested help 2022-09-15 16:24:59 -05:00
escaped-positional.rs fix: Make arg!(--flag <value>) optional by default 2022-09-12 17:10:01 -05:00
find.md fix: Make arg!(--flag <value>) optional by default 2022-09-12 17:10:01 -05:00
find.rs fix: Switch to owned types 2022-08-22 14:55:55 -05:00
git-derive.md docs(cookbook): Provide example of --color[=WHEN] 2022-09-30 20:33:36 -05:00
git-derive.rs docs(cookbook): Provide example of --color[=WHEN] 2022-09-30 20:33:36 -05:00
git.md docs(cookbook): Provide example of --color[=WHEN] 2022-09-30 20:33:36 -05:00
git.rs docs(cookbook): Provide example of --color[=WHEN] 2022-09-30 20:33:36 -05:00
multicall-busybox.md fix(help): Make output more dense 2022-09-07 17:13:55 -05:00
multicall-busybox.rs fix: Switch to owned types 2022-08-22 14:55:55 -05:00
multicall-hostname.md fix!: Remove App alias for Command 2022-07-21 15:08:37 -05:00
multicall-hostname.rs feat(multicall): Stablize multicall 2022-05-20 12:20:40 -05:00
pacman.md fix(help): Separate command flags like options 2022-09-19 09:07:43 -05:00
pacman.rs feat(parser): Provide convenience for SetTrue 2022-09-01 19:40:56 -05:00
README.md doc(fix typo): add missing "l" in "toml" 2022-10-01 20:36:01 +02:00
repl.rs style: Update for latest clippy 2022-12-22 12:25:33 -06:00
typed-derive.md fix(error): Be more consistent in error quoting 2022-10-13 10:45:38 -05:00
typed-derive.rs docs(cookbook): PossibleValues with custom types 2022-10-05 19:12:05 -05:00

README.md

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