Add comprehensive documentation to Pattern Reversal VEP experiment#3
Open
Add comprehensive documentation to Pattern Reversal VEP experiment#3
Conversation
Added detailed docstrings and comments to the VisualPatternReversalVEP class: - Module-level documentation explaining the P100 component and clinical applications - Class-level documentation with usage examples - Comprehensive docstrings for all methods including __init__, load_stimulus, present_stimulus, etc. - Inline comments explaining VR vs monitor modes, checkerboard parameters, and timing - Documentation of standard clinical parameters (1 degree check size, 2 Hz reversal rate) - Updated __init__.py to properly export the VisualPatternReversalVEP class The documentation follows Python docstring conventions and matches the style used in other eeg-notebooks experiments.
- Created comprehensive VEP documentation page (doc/experiments/vvep.rst) - Added VEP experiment to doc index toctree - Documented Pattern Reversal VEP for P100 measurement - Included clinical applications, standard parameters, and experiment design - Documentation builds successfully and renders correctly in HTML - Follows existing documentation style and structure The documentation includes: - Overview of Visual Evoked Potentials - P100 component characteristics and significance - Clinical applications (MS diagnosis, optic neuritis, etc.) - ISCEV standard parameters (1 degree checks, 2 Hz reversal) - Support for both monitor and VR (Meta Quest 2) modes - Monocular recording with alternating eye blocks
- Updated module docstring path reference in pattern_reversal_vep.py - Updated project name reference in VEP documentation (vvep.rst) - Ensures consistent branding throughout the documentation
- Updated all references from 'Quest 2' to 'Meta Quest' for consistency - Updated in both code documentation and RST files - Changes include: - Module docstring - Function parameters and docstrings - Inline comments - Documentation RST file This provides more generic VR headset naming that applies to the entire Meta Quest line rather than a specific model.
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.
Added detailed docstrings and comments to the VisualPatternReversalVEP class:
The documentation follows Python docstring conventions and matches the style
used in other eeg-notebooks experiments.