diff options
| author | 2020-08-28 17:26:01 +1000 | |
|---|---|---|
| committer | 2020-08-28 09:43:42 +0200 | |
| commit | a3d2a261f59983838e3ed5f01d90f18352e6a421 (patch) | |
| tree | 834fb4e483fd92a6b6d29ca89482fbfb87b7089a /example/README.md.template | |
| parent | reverse the order of these (diff) | |
| download | zig-clap-a3d2a261f59983838e3ed5f01d90f18352e6a421.tar.gz zig-clap-a3d2a261f59983838e3ed5f01d90f18352e6a421.tar.xz zig-clap-a3d2a261f59983838e3ed5f01d90f18352e6a421.zip | |
adjust examples, README template
Diffstat (limited to '')
| -rw-r--r-- | example/README.md.template | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/example/README.md.template b/example/README.md.template index 2afbe86..65b507d 100644 --- a/example/README.md.template +++ b/example/README.md.template | |||
| @@ -14,6 +14,7 @@ into master on every `zig` release. | |||
| 14 | * Supports both passing values using spacing and `=` (`-a 100`, `-a=100`) | 14 | * Supports both passing values using spacing and `=` (`-a 100`, `-a=100`) |
| 15 | * Short args also support passing values with no spacing or `=` (`-a100`) | 15 | * Short args also support passing values with no spacing or `=` (`-a100`) |
| 16 | * This all works with chaining (`-ba 100`, `-ba=100`, `-ba100`) | 16 | * This all works with chaining (`-ba 100`, `-ba=100`, `-ba100`) |
| 17 | * Supports options that can be specified multiple times (`-e 1 -e 2 -e 3`) | ||
| 17 | * Print help message from parameter specification. | 18 | * Print help message from parameter specification. |
| 18 | * Parse help message to parameter specification. | 19 | * Parse help message to parameter specification. |
| 19 | 20 | ||
| @@ -28,7 +29,8 @@ The simplest way to use this library is to just call the `clap.parse` function. | |||
| 28 | ``` | 29 | ``` |
| 29 | 30 | ||
| 30 | The data structure returned has lookup speed on par with array access (`arr[i]`) and validates | 31 | The data structure returned has lookup speed on par with array access (`arr[i]`) and validates |
| 31 | that the strings you pass to `option` and `flag` are actually parameters that the program can take: | 32 | that the strings you pass to `option`, `options` and `flag` are actually parameters that the |
| 33 | program can take: | ||
| 32 | 34 | ||
| 33 | ```zig | 35 | ```zig |
| 34 | {} | 36 | {} |