Added docstrings to any undocumented public-facing functions

jldbc / pybaseball

Pull current and historical baseball statistics using Python (Statcast, Baseball Reference, FanGraphs)

MIT License

1.25k stars 333 forks source link

Added docstrings to any undocumented public-facing functions #340

Closed erin2722 closed 1 year ago

erin2722 commented 1 year ago

Based on the discussion in #298, I combed through the codebase and added docstrings to any public-facing functions that did not already have them.

Let me know if this was overkill, and I can go back through and remove some docstrings, or change the formatting!

erin2722 commented 1 year ago

Thank you for the quick feedback @tjburch !! I just responded to the initial feedback, and will respond to more as it comes up!

tjburch commented 1 year ago

cool, this lgtm. Appreciate it. I'll leave it to @schorrm to merge, so he at least gets eyes on it since it's been an ongoing discussion.

schorrm commented 1 year ago

LGTM!

tjburch commented 1 year ago

This CI business is getting to be a nightmare.

tjburch commented 1 year ago

Ok, I resolved the CI stuff in another PR. I'll just go ahead and merge this. Since it's only docstrings, I'm not too worried about it. Thanks for the contribution @erin2722!