Skip to content

Commit

Permalink
Add missing docs for row_validators attribute (di#94)
Browse files Browse the repository at this point in the history
This class attribute and init argument were added in di#82, but this
documentation was not included in the initial PR.

Additionally, fixes a readme typo.
  • Loading branch information
jonafato authored Mar 15, 2024
1 parent 48f92e1 commit 538e93e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,12 @@ Running Vlads Programatically
List of validators. Optional, defaults to the class variable `validators`
if set, otherwise uses `EmptyValidator` for all fields.

:``row_validators=[]``:
List of row-level validators. Validators provided here operate on entire
rows and can be used to define constraints that involve more than one
field. Optional, defaults to the class variable `row_validators` if set,
otherwise `[]`, which does not perform any row-level validation.

:``delimiter=','``:
The delimiter used within your csv source. Optional, defaults to `,`.

Expand Down Expand Up @@ -411,7 +417,7 @@ Contributors
- `Bob Lannon <https://github.com/boblannon>`__
- `Santi <https://github.com/santilytics>`__
- `David Park <https://github.com/dp247>`__
- `Jon Bonafato <https://github.com/jonafato>`__
- `Jon Banafato <https://github.com/jonafato>`__
- `haritha-ravi <https://github.com/haritha-ravi>`__
License
Expand Down

0 comments on commit 538e93e

Please sign in to comment.