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

Clarify the usage of custom type #137

Merged
merged 1 commit into from
Oct 5, 2024
+2 −3
Merged

Clarify the usage of custom type #137

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
5 changes: 2 additions & 3 deletions lib/nimble_options.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,8 @@ defmodule NimbleOptions do
called `:one_of` and the `:in` name is available since version 0.3.3 (`:one_of`
has been removed in v0.4.0).
* `{:custom, mod, fun, args}` - A custom type. The related value must be validated
by `mod.fun(values, ...args)`. The function should return `{:ok, value}` or
`{:error, message}`.
* `{:custom, mod, fun, args}` - A custom type. The related value will be validated
by `apply(mod, fun, [value | args])`. `fun` should return `{:ok, value}` or `{:error, message}`.
* `{:or, subtypes}` - A value that matches one of the given `subtypes`. The value is
matched against the subtypes in the order specified in the list of `subtypes`. If
Expand Down
Loading