Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 06:42:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3163 from epage/docs

Browse source 
docs: List out each API
This commit is contained in:
Ed Page 2021-12-13 09:07:30 -06:00 committed by GitHub
commit 0b9aa487f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/FAQ.md
View file

@ -55,17 +55,19 @@ Depending on the style in which you choose to define the valid arguments, `clap`
* You want to use subcommands (although other libraries also support subcommands, they are not nearly as feature rich as those provided by `clap`) * You want to use subcommands (although other libraries also support subcommands, they are not nearly as feature rich as those provided by `clap`)
* You want some sort of custom validation built into the argument parsing process, instead of as part of your application (which allows for earlier failures, better error messages, more cohesive experience, etc.) * You want some sort of custom validation built into the argument parsing process, instead of as part of your application (which allows for earlier failures, better error messages, more cohesive experience, etc.)
### How many approaches are there to create an App/Arg? ### How many approaches are there to create a parser?
To build an `App` there are two: The following APIs are supported:
- [Derive](../examples/tutorial_derive/README.md)
- [Builder](../examples/tutorial_builder/README.md)
- Derive Macros Previously, we supported:
- Builder Pattern - [YAML](https://github.com/clap-rs/clap/issues/3087)
- [docopt](http://docopt.org/)-inspired [usage parser](https://github.com/clap-rs/clap/issues/3086)
- [`clap_app!`](https://github.com/clap-rs/clap/issues/2835)
To build an `Arg` there are two: There are also experiments with other APIs:
- [fncmd](https://github.com/yuhr/fncmd): function attribute
- Derive Macros
- Builder Pattern
### Why is there a default subcommand of help? ### Why is there a default subcommand of help?