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

Modified README.rst Code Examples #797

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JodyAHunter
Copy link

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'

Some examples provided in the README.rst file were no
longer functional. I swapped those examples out with
functional features and added expected outputs to
all examples in README.rst file. 

Signed-Off-By: Jody Hunter <[email protected]>
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 this pull request may close these issues.

Updating Examples section of the README.rst file
1 participant