roclark / sportsipy

A free sports API written for python
MIT License
484 stars 187 forks source link

Modified README.rst Code Examples #797

Open JodyAHunter opened 4 months ago

JodyAHunter commented 4 months ago

Some README.rst code examples were either no longer functional or produced no output. I swapped those examples out with functional features or modified them to produce output and added expected outputs to all examples in README.rst file. This should improve new user experience in learning how to utilize the software and what to expect from examples being followed.

Changed the 'Get instances of all NHL teams for the 2018 season' to 'Get stats of a specified NHL player'. Changed the 'Get a specific NFL team's season information' to 'Get a specific NFL team's wins and losses for the season'. Changed the 'Get a Pandas DataFrame of all stats for an MLB game' to 'Get the batting average and home run total for each MLB team' due to Pandas functionality producing errors.

'closes #793'