Skip to content

Commit bd1f1ca

Browse files
authored
Add missing API doc entries for save*, dump*, remove_channels, and scale_to_uV (#4451)
1 parent 37ff412 commit bd1f1ca

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/api.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,33 @@ spikeinterface.core
88
.. autofunction:: load
99
.. autoclass:: BaseRecording
1010
:members:
11+
.. automethod:: BaseRecording.save
12+
.. automethod:: BaseRecording.save_to_memory
13+
.. automethod:: BaseRecording.save_to_folder
14+
.. automethod:: BaseRecording.save_to_zarr
15+
.. automethod:: BaseRecording.dump
16+
.. automethod:: BaseRecording.dump_to_json
17+
.. automethod:: BaseRecording.dump_to_pickle
18+
.. automethod:: BaseRecording.remove_channels
1119
.. autoclass:: BaseSorting
1220
:members:
21+
.. automethod:: BaseSorting.save
22+
.. automethod:: BaseSorting.save_to_memory
23+
.. automethod:: BaseSorting.save_to_folder
24+
.. automethod:: BaseSorting.save_to_zarr
25+
.. automethod:: BaseSorting.dump
26+
.. automethod:: BaseSorting.dump_to_json
27+
.. automethod:: BaseSorting.dump_to_pickle
1328
.. autoclass:: BaseSnippets
1429
:members:
30+
.. automethod:: BaseSnippets.save
31+
.. automethod:: BaseSnippets.save_to_memory
32+
.. automethod:: BaseSnippets.save_to_folder
33+
.. automethod:: BaseSnippets.save_to_zarr
34+
.. automethod:: BaseSnippets.dump
35+
.. automethod:: BaseSnippets.dump_to_json
36+
.. automethod:: BaseSnippets.dump_to_pickle
37+
.. automethod:: BaseSnippets.remove_channels
1538
.. autoclass:: BaseEvent
1639
:members:
1740
.. autoclass:: SortingAnalyzer
@@ -204,6 +227,7 @@ spikeinterface.preprocessing
204227
.. autofunction:: remove_artifacts
205228
.. autofunction:: resample
206229
.. autofunction:: scale
230+
.. autofunction:: scale_to_uV
207231
.. autofunction:: silence_periods
208232
.. autofunction:: unsigned_to_signed
209233
.. autofunction:: whiten

0 commit comments

Comments
 (0)