search

miso-sound / misosoupy

Misophonia Stimulus Organization Using Python
MIT License
0 stars 0 forks source link

Adding docstrings #3

Closed danibene closed 1 month ago

danibene commented 11 months ago

These days, I usually like to document my python functions with either NumPy or Google-style docstrings. Thoughts/preferences?

hansen508 commented 11 months ago

I admittedly did not know docstrings were a thing and had to google them. They seem similar enough to me that I don't have an immediate preference, so I'll let you choose and then learn that one!

danibene commented 11 months ago

Awesome! Want to go with NumPy then? If you feel comfortable/have time you could create a new branch based on dev and add docstrings to the existing functions, and open a pull request, otherwise I am happy to do it later

hansen508 commented 11 months ago

Sounds good! Let me try first, I want to learn