DOC: Add missing links to supported data format tables in events tutorialSusani/explore docs#13715
Open
Susaniaariya wants to merge 3 commits intomne-tools:mainfrom
Open
DOC: Add missing links to supported data format tables in events tutorialSusani/explore docs#13715Susaniaariya wants to merge 3 commits intomne-tools:mainfrom
Susaniaariya wants to merge 3 commits intomne-tools:mainfrom
Conversation
drammock
reviewed
Mar 2, 2026
| # (once such a table has been created). | ||
| # For a list of which EEG/MEG systems use STIM channels versus marker files | ||
| # or embedded arrays, see the "Supported data formats" tables in | ||
| # :doc:`/auto_tutorials/io/10_reading_meg_data` and :doc:`/auto_tutorials/io/20_reading_eeg_data`. |
Member
There was a problem hiding this comment.
neither of the linked pages contain a table called "supported data formats".
Author
There was a problem hiding this comment.
Hi Daniel,
Thank you for your feedback! I’ve addressed the TODO comment in 20_events_from_raw.py by adding functional cross-references to the MEG and EEG tutorials. I also clarified the surrounding comment to make the explanation more precise.
The changes are now pushed to my branch, and I’ve opened a pull request for review. Please let me know if there are any further improvements you’d like me to make.
Best regards,
Susaniaariya
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Reference issue (if any)
No specific issue, but this PR addresses a
TODOcomment found intutorials/intro/20_events_from_raw.pyregarding missing links to supported data format tables.What does this implement/fix?
This PR replaces the
TODOtext with functional cross-references to the MEG and EEG "Supported data formats" tables.I used the
:doc:role to link directly to:tutorials/io/10_reading_meg_data.pytutorials/io/20_reading_eeg_data.py:doc:because these source files do not currently have internal labels defined (which would be required for:ref:).Additional information
I am a GSoC 2026 applicant for the Project 4: Interactive Documentation (JupyterLite) project.
Building these docs locally and troubleshooting the Sphinx cross-referencing logic gave me great insight into the current documentation workflow and why the JupyterLite initiative is so important for reducing contributor friction
I am really excited for JupyterLite to make this process even smoother for future contributors.