spikeinterface icon indicating copy to clipboard operation
spikeinterface copied to clipboard

`correct_motion_on_peaks` is not included in the API docs

Open JoeZiminski opened this issue 1 year ago • 3 comments

Not sure why, I will look into this ASAP.

JoeZiminski avatar Jun 25 '24 16:06 JoeZiminski

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

JoeZiminski avatar Jun 25 '24 17:06 JoeZiminski

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!

chrishalcrow avatar Jun 26 '24 10:06 chrishalcrow

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

samuelgarcia avatar Jun 26 '24 10:06 samuelgarcia

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.

chrishalcrow avatar Jul 19 '24 07:07 chrishalcrow