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

[Nick-Seinsche]

Adding an example to the docs that previously caused confusion. See issue 1794.. This should close the issue.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.28%. Comparing base (812b2a8) to head (bf1ae78).
Report is 161 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1809      +/-   ##
==========================================
- Coverage   94.28%   93.28%   -1.00%     
==========================================
  Files          91      120      +29     
  Lines        7013     9134    +2121     
==========================================
+ Hits         6612     8521    +1909     
- Misses        401      613     +212     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cosmicBboy]

So the issue referenced here #1794 is actually a bug. The docs that are changed in this PR actually refers to built-in types like int, float, etc.:

# input y will not be validated
@pa.check_types()
def fn(x: DataFrameSchema[Schema], y: int): ...

# input y will not be validated
@pa.check_types(with_pydantic=True)
def fn(x: DataFrameSchema[Schema], y: int): ...

will close this issue. Thanks for the proactiveness though!