Control example order via explicit list, not via sorting titles #1321
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drammock
commented
Oct 15, 2024
| "rename_brainvision_files.py", | ||
| "convert_mri_and_trans.py", | ||
| "convert_ieeg_to_bids.py", | ||
| "convert_nirs_to_bids.py", |
There was a problem hiding this comment.
this is the one that was previously a duplicate "13" and appearing last. I thought it made more sense to group it with other "converting XXX to BIDS" examples.
Aside: if anyone has strong feelings about order / wants to take this opportunity to shuffle the order a bit more, feel free to push a commit changing this file.
mne_bids/utils.py
Outdated
Comment on lines
522
to
524
| # better example sorting, without relying on numbers in example titles | ||
| with open(Path(__file__).parents[1] / "doc" / "example_order.json") as fid: | ||
| EXAMPLE_ORDER = json.load(fid) |
There was a problem hiding this comment.
NB: the JSON file won't be included in the built wheel, but that shouldn't matter as it's only needed when building our docs, so we can assume a clone of the repo in that case.
sappelhoff
reviewed
Oct 16, 2024
|
just a note that this needs sphinx-gallery/sphinx-gallery#1391 before the CIs will pass. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
This PR removes numbering from the titles of the examples, and switches the example ordering heuristic from relying on the (no-longer-numbered) titles, to instead relying on a JSON file containing example filenames in a fixed order. Motivation is that:
Safeguards:
closes #1320
Merge checklist
Maintainer, please confirm the following before merging.
If applicable: