You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: