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

Support optional `description` (or `desc`) field on Column and Check objects #728

Closed smackesey closed 2 years ago

smackesey commented 2 years ago
smackesey commented 2 years ago

@cosmicBboy Is this a feature you would accept a PR for?

cosmicBboy commented 2 years ago

yes! this feature has some overlap with https://github.com/pandera-dev/pandera/issues/331

Basically the request is to add title and description to schemas and schema components for both the DataFrameSchema and SchemaModel syntax.

Would you be open to make a PR that addresses both issues? Basically these are all the components where title and description would make sense:

I'm also open to a more incremental approach if you want to start with Column/Field and Check