Ything-RepoMirrors/clap

mirror of https://github.com/clap-rs/clap.git synced 2026-01-25 05:06:35 +00:00

Files

History

Ed Page 667ead6e59 style: Make clippy happy

2025-10-31 13:47:50 -05:00

..

fix(derive): Match rustc's error style

2025-09-02 11:53:35 -05:00

tutorial_builder

style: Make clippy happy

2025-10-31 13:47:50 -05:00

tutorial_derive

docs(derive): Specify arg_required_else_help is set for users

2025-05-23 13:02:16 -05:00

fix(help): Correctly calculate padding for short-only args

2025-10-29 09:12:41 -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(cookbook): Style cargo plugin

2024-08-08 10:31:27 -05:00

cargo-example.md

fix(help): Remove extraneous text from built-ins

2023-01-03 11:02:26 -06:00

cargo-example.rs

docs(cookbook): Style cargo plugin

2024-08-08 10:31:27 -05:00

demo.md

fix(help): Remove extraneous text from built-ins

2023-01-03 11:02:26 -06:00

demo.rs

chore: Update from template

2024-05-14 12:27:02 -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(tutorial): Don't cover 'author' as its not shown

2024-01-17 08:06:56 -06: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

Revert "feat(help): Only print short when required"

2025-04-11 14:33:29 -05:00

find.rs

docs(cookbook): Clarify intent of fake flags

2024-01-08 10:14:37 -06:00

git-derive.md

fix(help): Align mixed argument types

2025-03-31 21:29:24 -04:00

git-derive.rs

feat(help): Allow controlling flattening

2023-11-09 13:31:11 -06:00

git.md

fix(help): Align mixed argument types

2025-03-31 21:29:24 -04:00

git.rs

feat(help): Allow controlling flattening

2023-11-09 13:31:11 -06: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

docs: Highlight notes/warnings in a block

2024-11-08 11:07:48 -06:00

pacman.rs

docs(tutorial): Don't cover 'author' as its not shown

2024-01-17 08:06:56 -06:00

README.md

doc(fix typo): add missing "l" in "toml"

2022-10-01 20:36:01 +02:00

repl-derive.rs

fix: Format chained method

2024-01-23 22:29:19 -05:00

repl.rs

chore: Inline simple non-mixed format args

2023-05-04 15:58:04 -04:00

README.md

Examples

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

Cookbook / How-To Guides
Tutorials (derive, builder)

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