Update and complete docstrings

neuromodulation / py_neuromodulation

Real-time analysis of intracranial neurophysiology recordings.

https://neuromodulation.github.io/py_neuromodulation/

MIT License

41 stars 9 forks source link

Update and complete docstrings #331

Open toni-neurosc opened 2 weeks ago

toni-neurosc commented 2 weeks ago

As changes have accumulated, many of the docstrings that the automated documentation is built off are either missing or outdated.

In order to ensure a correct and complete documentation, docstrings need to be updated all across the project, starting with the nm_settings module.

Related PR: #329

timonmerk commented 2 weeks ago

Great! Let's work on this once the API is fixed and #329 is ready to be merged

timonmerk commented 1 week ago

Just to let you know, I am working on this now @toni-neurosc