Skip to content

Commit

Permalink
Final touches to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alejoe91 committed Jul 15, 2024
1 parent 2bf7571 commit de14d02
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/modules/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ and merging unit groups.
sorting_analyzer_merge = sorting_analyzer.merge_units([0, 1], [2, 3])
All computed extensions will be automatically propagated or merged when curating. Please refer to the
:ref:`modules/curation` documentation for more information.
:ref:`modules/curation:Curation module` documentation for more information.


Event
Expand Down
1 change: 1 addition & 0 deletions doc/modules/curation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _curation:

Curation module
===============

Expand Down
2 changes: 1 addition & 1 deletion doc/modules/preprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ These two preprocessors will not compute anything at instantiation, but the comp
traces = recording_cmr.get_traces(start_frame=100_000, end_frame=200_000)
Some internal sorters (see :ref:`modules/sorters:Intertnal Sorters`) can work directly on these preprocessed objects so there is no need to
Some internal sorters (see :ref:`modules/sorters:Internal Sorters`) can work directly on these preprocessed objects so there is no need to
save the object:

.. code-block:: python
Expand Down
4 changes: 2 additions & 2 deletions doc/modules/sorters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -473,8 +473,8 @@ Here is the list of external sorters accessible using the run_sorter wrapper:
* **HDSort** :code:`run_sorter(sorter_name='hdsort')`
* **YASS** :code:`run_sorter(sorter_name='yass')`

Intertnal Sorters
-----------------
Internal Sorters
----------------

Here a list of internal sorter based on `spikeinterface.sortingcomponents`; they are totally
experimental for now:
Expand Down
2 changes: 1 addition & 1 deletion doc/modules/widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ The functions have the following additional arguments:
# sortingview backend
w_ts = sw.plot_traces(recording=recording, backend="sortingview")
w_ss = sw.plot_sorting_summary(waveform_extractor=we, curation=True, backend="sortingview")
w_ss = sw.plot_sorting_summary(sorting_analyzer=sorting_analyzer, curation=True, backend="sortingview")
**Output:**
Expand Down

0 comments on commit de14d02

Please sign in to comment.