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

Updating Examples section of the README.rst file #793

Open
JodyAHunter opened this issue May 24, 2024 · 0 comments · May be fixed by #797
Open

Updating Examples section of the README.rst file #793

JodyAHunter opened this issue May 24, 2024 · 0 comments · May be fixed by #797

Comments

@JodyAHunter
Copy link

Is your feature request related to a problem? Please describe.
When testing the software, I realized that some of the provided examples from the README.rst file showcased features that are either currently not functioning properly or do not create any output. I think that modifying these examples would improve new user experience.

Describe the solution you'd like
I believe that changing the non-functioning feature examples to features that still have proper functionality, expanding on the examples that do not create any output, and adding expected output to all examples would greatly improve this section of the README.rst file and help encourage new users that are trying to learn how to use the software.

Examples that appeared to no longer have proper functionality

Get a Pandas DataFrame of all stats for a MLB game

Examples that produced no output that could be expanded upon

Get instances of all NHL teams for the 2018 season
Get a specific NFL team's season information

@JodyAHunter JodyAHunter linked a pull request Jun 5, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant