search

miso-sound / misosoupy

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

add docstrings, incorporate feedback from other pull request #9

Closed hansen508 closed 1 month ago

hansen508 commented 1 month ago

Howdy! Thanks for your patience as I trudge along with this.

I've incorporated your feedback from the last pull request (added separate function for homeDir, renamed variables, removed commented out code) and pushed those changes to dev already.

This branch has my attempt at adding NumPy docstrings to the functions. In typing these out, I became painfully aware how many inputs these functions have and fully acknowledge this could probably be done more efficiently (but whatevs). Feel free to edit as you see fit, or let me know if massive changes/additions should be made.

Still tinkering around with additional functionality/customizability to add...

danibene commented 1 month ago

This looks good! I think it's ready to merge.

For the many parameters, you could consider grouping similar ones (like the colors customization) and/or having a configuration file e.g.: https://github.com/juliencegarra/OpenMATB/blob/master/config.ini