roclark / sportsipy

A free sports API written for python
MIT License
475 stars 189 forks source link

Updating Examples section of the README.rst file #793

Open JodyAHunter opened 1 month ago

JodyAHunter commented 1 month ago

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