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.

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

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

Closed
smackesey opened this issue Jan 10, 2022 · 2 comments
Closed
Labels
enhancement New feature or request

Comments

@smackesey
Copy link
Contributor

  • This would be useful for tools that wrap Pandera and display rich schema info in a UI (Dagster has this planned)
  • The description can already be specified in check functions specified in schema model classes.
  • Built-in checks could generate their own descriptions based on args.
@smackesey smackesey added the enhancement New feature or request label Jan 10, 2022
@smackesey smackesey changed the title Support optional description (or desc) field on Check objects Support optional description (or desc) field on Column and Check objects Jan 31, 2022
@smackesey
Copy link
Contributor Author

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

@cosmicBboy
Copy link
Collaborator

yes! this feature has some overlap with #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:

  • DataFrameSchema (also applies to pandera.MultiIndex)
    • SchemaModel.Config would forward the properties to DataFrameSchema
  • SeriesSchemaBase (this applies to SeriesSchema, Column, pandera.Index)
    • Field would forward the properties to Column/Index
  • Check

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants