Skip to content
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

Adding an example to the docs to avoid confusion in the future #1809

Closed
wants to merge 1 commit into from
Closed

Adding an example to the docs to avoid confusion in the future #1809

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
5 changes: 4 additions & 1 deletion docs/source/dataframe_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,10 @@ except pa.errors.SchemaErrors as exc:
```

Note that mixtures of `DataFrame` schemas and built-in types will ignore checking built-in types
with pandera. Pydantic should be used to check and/or coerce any built-in types.
with pandera. For example, for a return value with annotation
`list[DataFrame[Schema], DataFrame[Schema]]` the elements of the list will not be checked
against the Schema.
Pydantic should be used to check and/or coerce any built-in types.

```{code-cell} python
import pandas as pd
Expand Down