Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-09-20 14:31:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/examples
History
Ed Page 234d5f91d1 fix(error): Change from neutral 'note' to helpful 'tip' 
This also has the advantage of aligning with `error:`

This is a small part of #4638
2023-03-27 20:45:11 -05:00
..
derive_ref fix(error): Change from neutral 'note' to helpful 'tip' 2023-03-27 20:45:11 -05:00
tutorial_builder docs: Prefer get_flag over get_one::<bool> 2023-01-23 09:23:38 -06:00
tutorial_derive feat(derive): Support #[group] attributes 2023-03-25 03:25:38 -05:00
cargo-example-derive.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06:00
cargo-example-derive.rs docs(examples): Differentiate struct from command name 2023-02-06 10:25:14 -06:00
cargo-example.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06:00
cargo-example.rs fix: Make arg!(--flag <value>) optional by default 2022-09-12 17:10:01 -05:00
demo.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06:00
demo.rs docs(derive): Update for new attributes 2022-09-02 15:39:13 -05:00
escaped-positional-derive.md fix(error): Try to soften unexpected argument/value errors 2023-01-13 21:29:49 -06:00
escaped-positional-derive.rs docs(derive): Update for new attributes 2022-09-02 15:39:13 -05:00
escaped-positional.md fix(error): Try to soften unexpected argument/value errors 2023-01-13 21:29:49 -06:00
escaped-positional.rs fix: Make arg!(--flag <value>) optional by default 2022-09-12 17:10:01 -05:00
find.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06:00
find.rs fix: Switch to owned types 2022-08-22 14:55:55 -05:00
git-derive.md docs(examples): Differentiate struct from command name 2023-02-06 10:25:14 -06:00
git-derive.rs docs(examples): Differentiate struct from command name 2023-02-06 10:25:14 -06:00
git.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06:00
git.rs Fix typo in git.rs 2023-02-07 23:13:52 +01:00
multicall-busybox.md fix(help): Remove extraneous text from built-ins 2023-01-03 11:02:26 -06: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(error): Match rustc for giving more information 2023-01-03 13:22:35 -06:00
pacman.rs chore: Make format!() calls more readable 2023-01-29 19:14:47 +00:00
README.md doc(fix typo): add missing "l" in "toml" 2022-10-01 20:36:01 +02:00
repl.rs chore: Make format!() calls more readable 2023-01-29 19:14:47 +00:00
typed-derive.md fix(error): Try to polish/clarify messages 2023-01-06 17:01:36 -06:00
typed-derive.rs chore: Make format!() calls more readable 2023-01-29 19:14:47 +00: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