search

SpikeInterface / spikeinterface

A Python-based module for creating flexible and robust spike sorting pipelines.
https://spikeinterface.readthedocs.io
MIT License
526 stars 187 forks source link

`correct_motion_on_peaks` is not included in the API docs #3083

Open JoeZiminski opened 4 months ago

JoeZiminski commented 4 months ago

Not sure why, I will look into this ASAP.

JoeZiminski commented 4 months ago

Same with load_motion_info, maybe a few from the motion correction are not there.

chrishalcrow commented 4 months ago

Just having a quick look at this: am I right in thinking that we maintain the api.rst file? I always thought sphinx did this for us!

samuelgarcia commented 4 months ago

Sphinx could do it but then we need a an automodule/autofunction/autoclass everywhere (mainly adding doc in all init.py) with the same probality to forget to add it. I think centralized is not so bad but we very often forgot to add new function and classes

chrishalcrow commented 3 months ago

Hello, Motion Correction is now there. But load_motion_info and save_motion_info. Should these be in the preprocessing api? If yes, I'll add them there.