Skip to content

Widen ValidationError :key type to allow lists #151

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

Open
cgarvis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Widen ValidationError :key type to allow lists #151

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
6 changes: 4 additions & 2 deletions lib/nimble_options/validation_error.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ defmodule NimbleOptions.ValidationError do
"""

@type t() :: %__MODULE__{
key: atom(),
key: atom() | [atom()],
keys_path: [atom()],
redact: boolean,
value: term()
Expand All @@ -21,7 +21,9 @@ defmodule NimbleOptions.ValidationError do
Only the following documented fields are considered public. All other fields are
considered private and should not be referenced:

* `:key` (`t:atom/0`) - The key that did not successfully validate.
* `:key` (`t:atom/0` or list of `t:atom/0`) - The key that did not successfully
validate. When several keys are involved in the same error (for example,
unknown options reported as a group), this is the list of those keys.

* `:keys_path` (list of `t:atom/0`) - If the key is nested, this is the path to the key.

Expand Down