Skip to content

Commit

Permalink
explanation of fix value
Browse files Browse the repository at this point in the history
Co-authored-by: zsimjee <[email protected]>
  • Loading branch information
CalebCourier and zsimjee authored Aug 1, 2024
1 parent 8e97799 commit dad9cc6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/concepts/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ def starts_with_a(value: str, metadata: Dict) -> ValidationResult:
)
```

:::note
A fix_value was supplied in the FailResult in the example above. This value represents a programmatic fix that can be applied to the output if `on_fail='fix'` is passed during validator initialization.
:::

If you need to perform more complex operations or require addtional arguments to perform the validation, then the validator can be specified as a class that inherits from our base Validator class:

```py
Expand Down

0 comments on commit dad9cc6

Please sign in to comment.