Skip to content

Commit

Permalink
correct spelling from README
Browse files Browse the repository at this point in the history
  • Loading branch information
xXMacMillanXx committed Oct 2, 2023
1 parent 4e6d4f4 commit 6d61a8a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ prep.add_key(prep.key('path', 'Path for input file').alias(['-p', '--path']).opt
prep.add_key(prep.key('count', 'Count down from the given integer').alias(['-c', '--count']).type_check(vcliargs.ArgTypes.integer))
// .type_check(ArgTypes) checks if the user input is convertable into the specified data type. Supported types are string, integer (int), float (f64) and boolean (bool).
// use the vcliargs.convert[T](input string) function to convert strings form the map you receive from parse() or cast it yourself.
// use the vcliargs.convert[T](input string) function to convert strings of the map you receive from parse() or cast it yourself.
prep.add_key(prep.key('count', 'Count down from the given integer').alias(['-c', '--count']).required(true))
// .required(true) makes it necessary for the parameter to need a value. THe value can come from default or user input.
// .required(true) makes it necessary for the parameter to need a value. The value can come from default or user input.
prep.add_key(prep.key('hidden', 'A hidden value to the user, but can be used internally.').default('something'))
// keys without .alias() won't be accessible by the user, only internally through code.
prep.add_key(prep.key('path', 'Path for input file').alias(['-p', '--path']).default('~/').multiple(true))
// these function can be used together to have more control over the accepted input
// these function can be used together to have more control over the accepted input.
```

Expand Down

0 comments on commit 6d61a8a

Please sign in to comment.