Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the description about range_tester #111

Merged
merged 1 commit into from
Sep 26, 2021
Merged

Improve the description about range_tester #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/src/arg_table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@ This is the list of all available settings:
and the option argument is not provided.
* `required` (default = `false`): determines if an argument is required (this setting is ignored by flags, which are always
optional, and in general should be avoided for options if possible).
* `range_tester` (default = `x->true`): a function returning a `Bool` value which tests whether an argument is allowed (e.g.
you could use `arg_type = Integer` and `range_tester = isodd` to allow only odd integer values)
* `range_tester` (default = `x->true`): a function returning `true` if an argument is allowed and otherwise returning `false` (e.g. you could use `arg_type = Integer` and `range_tester = isodd` to allow only odd integer values)
* `dest_name` (default = auto-generated): the key which will be associated with the argument in the `Dict` object returned by
`parse_args`. The auto-generation rules are explained in the [Argument names](@ref) section. Multiple arguments can share
the same destination, provided their actions and types are compatible.
Expand Down