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

Review fixes #59

Merged
merged 4 commits into from
Mar 23, 2020
Merged

Review fixes #59

merged 4 commits into from
Mar 23, 2020

Conversation

vanandsh
Copy link
Collaborator

  • Updated metadata for authors etc. information in pyproject.toml
  • Updated docstring for season_type argument in nba_scraper.py
  • Updated docstring to include example outputs in nba_team_stats.py
  • Updated code to round the numbers for mean and std columns in nba_team_stats.py
  • Rendered docs for local viewing

@vanandsh vanandsh added the documentation Improvements or additions to documentation label Mar 23, 2020
@vanandsh vanandsh added this to the Final Milestone milestone Mar 23, 2020
@codecov
Copy link

codecov bot commented Mar 23, 2020

Codecov Report

Merging #59 into master will not change coverage by %.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #59   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          295       295           
=========================================
  Hits           295       295           
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)
Impacted Files Coverage Δ
pysketball/nba_scraper.py 100.00% <ø> (ø)
pysketball/nba_team_stats.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b1834e...cc00014. Read the comment docs.

@AndresPitta
Copy link
Collaborator

AndresPitta commented Mar 23, 2020

Hey @vanandsh,

I see this PR addresses the following feedback:

  • Updated metadata for authors etc. information in pyproject.toml, given by @zoepan00 in issue #31:

I seem can't find the metadata for authors etc. information

  • Updated docstring for season_type argument in nba_scraper.py, given by @zoepan00 in issue #31:

Docstring for season_type argument is not updated. I think it would be either regular or postseason

  • Updated docstring to include example outputs in nba_team_stats.py, to address @zoepan00:

it would be nice to have the rendered outputs for nba_ranking, nba_boxplot, nba_team_stats

and @kvarada (#31):

Some of the usage examples in the docstrings are not complete. In many cases, the output is missing. For example, in your docstring of nba_ranking function, I would give an example with a toy CSV which has similar to your scraped CSV (e.g., NAME, GP columns). Also, showing the output of the example (the dataframe and not the plot) would help.

  • Updated code to round the numbers for mean and std columns in nba_team_stats.py, given by @zoepan00:

It would be nice if you can round the numbers for mean and std columns.

Thanks,
Andres

Copy link
Collaborator

@AndresPitta AndresPitta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes

Copy link
Collaborator

@carlinakim carlinakim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@AndresPitta AndresPitta merged commit 2fdf580 into master Mar 23, 2020
@AndresPitta AndresPitta mentioned this pull request Mar 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants