Add documentation on class-based API

unionai-oss / pandera

A light-weight, flexible, and expressive statistical data testing library

https://www.union.ai/pandera

MIT License

3.27k stars 305 forks source link

Closed cosmicBboy closed 3 years ago

cosmicBboy commented 3 years ago

The new class-based API #258 feature needs documentation, the documentation written by @jeffzi is a good start:

add module to the API reference
add an entry for pydantic-style API that should be referenced in the index.rst. Some things to include:
- basic usage: SchemaModel, Fields, etc.
- notes on using this feature with mypy
- class-based inheritance of schemas

cosmicBboy commented 3 years ago

@jeffzi let me know if there's anything else in the usage guide to include, in addition to what you've already outlined here: https://github.com/pandera-dev/pandera/pull/258#issuecomment-692984345

jeffzi commented 3 years ago

Thanks, sounds good to me.

jeffzi commented 3 years ago

Another point is to clearly explain that pandera does not really provide static type-checking.

cosmicBboy commented 3 years ago

fixed by #289