dtsong / sleeper-api-wrapper

A Python API wrapper for Sleeper's API: https://docs.sleeper.app/
MIT License
61 stars 21 forks source link

Add docstrings for all non-Stats files #23

Closed wfordh closed 10 months ago

wfordh commented 10 months ago

I added docstrings for all of the source files except stats.py since it has some functional changes waiting in PR #20 and I figured we could wait on that to make the changes. I tried to stay away from any functional changes in these files as I wanted this PR to be purely aesthetic, though I definitely found some spots that I'd like to clean up in future PRs. Once again the branch is pulled from and compared to the add_type_hints one since that's where this work started.

I used Google style for the docstrings, though I added type annotations to them.

I did add some logging messages to the players.py file to match what Sleeper has in their documentation, too.