Skip to content

Commit

Permalink
Simplify API module depth (#515)
Browse files Browse the repository at this point in the history
* Simplify API module depth

* Update changelog.rst
  • Loading branch information
rob-luke authored May 31, 2023
1 parent 1f89848 commit 5f005d7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 14 deletions.
15 changes: 3 additions & 12 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,6 @@ MNE-Python
MNE-NIRS
^^^^^^^^

.. currentmodule:: mne_nirs.io.snirf

.. automodule:: mne_nirs.io.snirf
:no-members:
:no-inherited-members:

.. autosummary::
:toctree: generated/

write_raw_snirf
read_snirf_aux_data

.. currentmodule:: mne_nirs.io

.. automodule:: mne_nirs.io
Expand All @@ -70,6 +58,9 @@ MNE-NIRS
.. autosummary::
:toctree: generated/


write_raw_snirf
read_snirf_aux_data
fold_landmark_specificity
fold_channel_specificity

Expand Down
4 changes: 2 additions & 2 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ General

Enhancements

* Update SNIRF exporter to meet v1.0 validator requirements :meth:`mne_nirs.io.snirf.write_raw_snirf`. By `Robert Luke`_.
* Update SNIRF exporter to meet v1.0 validator requirements :meth:`mne_nirs.io.write_raw_snirf`. By `Robert Luke`_.
* Add ability to provide custom channel weighting in :meth:`mne_nirs.statistics.RegressionResults.to_dataframe_region_of_interest` computation. By `Robert Luke`_.
* Add function to plot montages on 3D brain with source, detector, and channel naming :func:`mne_nirs.visualisation.plot_3d_montage`. By `Eric Larson`_.

Expand Down Expand Up @@ -155,7 +155,7 @@ Documentation

Bugs

* Fix inconsistencies between files written via :meth:`mne_nirs.io.snirf.write_raw_snirf` and the `current version <https://github.com/fNIRS/snirf/blob/52de9a6724ddd0c9dcd36d8d11007895fed74205/snirf_specification.md>`_ of the official SNIRF spec. By `Darin Erat Sleiter`_.
* Fix inconsistencies between files written via :meth:`mne_nirs.io.write_raw_snirf` and the `current version <https://github.com/fNIRS/snirf/blob/52de9a6724ddd0c9dcd36d8d11007895fed74205/snirf_specification.md>`_ of the official SNIRF spec. By `Darin Erat Sleiter`_.


Infrastructure
Expand Down

0 comments on commit 5f005d7

Please sign in to comment.