diff options
Diffstat (limited to 'example/README.md.template')
| -rw-r--r-- | example/README.md.template | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/example/README.md.template b/example/README.md.template index dda0cc9..d234dcd 100644 --- a/example/README.md.template +++ b/example/README.md.template | |||
| @@ -61,10 +61,10 @@ The simplest way to use this library is to just call the `clap.parse` function. | |||
| 61 | 61 | ||
| 62 | The result will contain an `args` field and a `positionals` field. `args` will have one field | 62 | The result will contain an `args` field and a `positionals` field. `args` will have one field |
| 63 | for each none positional parameter of your program. The name of the field will be the longest | 63 | for each none positional parameter of your program. The name of the field will be the longest |
| 64 | name of the parameter. | 64 | name of the parameter. `positionals` be a tuple with one field for each positional parameter. |
| 65 | 65 | ||
| 66 | The fields in `args` are typed. The type is based on the name of the value the parameter takes. | 66 | The fields in `args` and `psotionals` are typed. The type is based on the name of the value the |
| 67 | Since `--number` takes a `usize` the field `res.args.number` has the type `usize`. | 67 | parameter takes. Since `--number` takes a `usize` the field `res.args.number` has the type `usize`. |
| 68 | 68 | ||
| 69 | Note that this is only the case because `clap.parsers.default` has a field called `usize` which | 69 | Note that this is only the case because `clap.parsers.default` has a field called `usize` which |
| 70 | contains a parser that returns `usize`. You can pass in something other than | 70 | contains a parser that returns `usize`. You can pass in something other than |