File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -9,7 +9,7 @@ defmodule NimbleOptions.ValidationError do
99 """
1010
1111 @ type t ( ) :: % __MODULE__ {
12- key: atom ( ) ,
12+ key: atom ( ) | [ atom ( ) ] ,
1313 keys_path: [ atom ( ) ] ,
1414 redact: boolean ,
1515 value: term ( )
@@ -21,7 +21,9 @@ defmodule NimbleOptions.ValidationError do
2121 Only the following documented fields are considered public. All other fields are
2222 considered private and should not be referenced:
2323
24- * `:key` (`t:atom/0`) - The key that did not successfully validate.
24+ * `:key` (`t:atom/0` or list of `t:atom/0`) - The key that did not successfully
25+ validate. When several keys are involved in the same error (for example,
26+ unknown options reported as a group), this is the list of those keys.
2527
2628 * `:keys_path` (list of `t:atom/0`) - If the key is nested, this is the path to the key.
2729
You can’t perform that action at this time.
0 commit comments