Skip to content

Commit

Permalink
more detailed docstring of pandera.model_components.Field (#671)
Browse files Browse the repository at this point in the history
* Add strictly typed pandas to readme (#649)

* docs: strictly typed pandas

* update readme with additional alternatives

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>

* more detailed docstring of Field

Co-authored-by: Simon Brugman <sbrugman@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
  • Loading branch information
3 people committed Nov 11, 2021
1 parent 46dc3a2 commit d75298f
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions pandera/model_components.py
Expand Up @@ -188,9 +188,16 @@ def Field(
The keyword-only arguments from ``eq`` to ``str_startswith`` are dispatched
to the built-in `~pandera.checks.Check` methods.
:param nullable: whether or not the column/index is nullable.
:param unique: whether column values should be unique
:param allow_duplicates: whether or not to accept duplicate values.
:param nullable: Whether or not the column/index can contain null values.
:param unique: Whether column values should be unique.
:param allow_duplicates: Whether or not column can contain duplicate
values.
.. warning::
This option will be deprecated in 0.8.0. Use the ``unique``
argument instead.
:param coerce: coerces the data type if ``True``.
:param regex: whether or not the field name or alias is a regex pattern.
:param ignore_na: whether or not to ignore null values in the checks.
Expand Down

0 comments on commit d75298f

Please sign in to comment.