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

Try_Pandera edits to be more clear and beginner friendly #1629

Open
hendera2 opened this issue May 8, 2024 · 2 comments
Open

Try_Pandera edits to be more clear and beginner friendly #1629

hendera2 opened this issue May 8, 2024 · 2 comments
Labels

Comments

@hendera2
Copy link

hendera2 commented May 8, 2024

Location of the documentation

Try Pandera Documentation:
https://colab.research.google.com/github/unionai-oss/pandera/blob/main/docs/source/notebooks/try_pandera.ipynb#scrollTo=a5af85e2

https://github.com/unionai-oss/pandera/blob/main/docs/source/notebooks/try_pandera.ipynb

Documentation problem

For a true beginner, the Try Pandera page is a little vague and confusing.

There are several examples mixed together (some to show errors and some to show correct behavior) and when I tried to recreate the examples locally, I ran into several errors because I was missing something or overriding something accidentally.

There were also many assumptions in the explanations for features or concepts that beginners may not be familiar with and are necessary to understanding the library's functionality.

Suggested fix for documentation

My suggestion is to edit the existing TryPandera page to be clearer in its instructions, include more detailed explanations and more links to other helpful documentation pages or external pages, and to organize the page better so that a beginner can follow the flow more easily from start to finish.

@hendera2 hendera2 added the docs label May 8, 2024
@hendera2
Copy link
Author

hendera2 commented May 9, 2024

I would love to work on this and provide some improvements to this documentation.

@cosmicBboy
Copy link
Collaborator

please open up a PR with the suggestions

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

No branches or pull requests

2 participants