search

nicolafan / pyleague-soccer-simulation

A Python soccer championship simulation
MIT License
5 stars 3 forks source link

added sphinx style docstrings to all methods outside classes #15

Closed isobarbaric closed 2 years ago

isobarbaric commented 2 years ago

Fixes: #14

added sphinx style docstrings to all methods outside classes (except for the League class) and wherever I wasn't sure about what a parameter was for, I put (not sure) next to those parameters to bring those to the attention of others who may know what those parameters are

other than that, my apologies if I did something wrong, I hope my edits will be useful :)

P.S. this is my first PR :D

nicolafan commented 2 years ago

Thank you so much for this PR! Your import changes were correct, I didn't know the imports I had were incorrect because they were working on my system (probably because I was using PyCharm with some kind of config.). Your edits will be super-useful! I hope you didn't have problems understanding methods etc. Thank you for your first PR :) :100: :1st_place_medal:

isobarbaric commented 2 years ago

Thank you so much for accepting my PR! Yeah, I changed the imports back to what you had originally since I thought what you had was what you wanted to go wth :). Nah, not all, I understood most of the stuff :)

This project is super cool!! Hope to continue contributing to this project in the future :D

nicolafan commented 2 years ago

Sure! A New PR is always welcome! :)