Skip to content

Commit 26299ff

Browse files
committed
clearer docstring
1 parent c4928a6 commit 26299ff

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

mne_bids/utils.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -521,12 +521,11 @@ def _import_nibabel(why="work with MRI data"):
521521

522522
# better example sorting, without relying on numbers in example titles
523523
def _example_sorter(filename):
524-
"""Sort for MNE-BIDS example filenames in a custom order.
524+
"""Sort MNE-BIDS example filenames in a custom order.
525525
526-
Examples not explicitly listed in `EXAMPLE_ORDER` above will be sorted at the end.
527-
This is here (instead of in `conf.py`) because it needs to be *importable* for it
528-
to work correctly in Sphinx Gallery / maintain serializability of the sphinx gallery
529-
config dict in `conf.py`.
526+
Examples not explicitly listed in `EXAMPLE_ORDER` will be sorted at the end. This
527+
function is defined here (instead of in `conf.py`) because it must be *importable*
528+
in order for the sphinx gallery config dict in `conf.py` to remain serializable.
530529
"""
531530
with open(Path(__file__).parents[1] / "doc" / "example_order.json") as fid:
532531
EXAMPLE_ORDER = json.load(fid)

0 commit comments

Comments
 (0)