-
Notifications
You must be signed in to change notification settings - Fork 8
[DOC] Improving API doc html page #143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR improves API documentation by adding comprehensive module docstrings, enhancing dataset class documentation, and reorganizing the documentation structure for better HTML page generation.
- Adds standardized module docstrings with author, license, and purpose information across all modules
- Enhances dataset class documentation with rich metadata, usage examples, and improved Sphinx formatting
- Removes test dataset from CSV and updates documentation build processes
Reviewed Changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds graphviz dependency for documentation |
| Multiple .py files | Adds standardized module docstrings with author/license headers |
| eegdash/dataset/registry.py | Replaces simple docstring generation with comprehensive rich docstrings including examples and metadata |
| eegdash/features/serialization.py | Improves docstring formatting and cross-references |
| eegdash/api.py | Enhances EEGDashDataset class examples with detailed usage patterns |
| docs/ files | Updates documentation structure, URLs, and build configuration |
| Dataset documentation files | Adds new dataset page generation and removes test data |
Comments suppressed due to low confidence (1)
eegdash/dataset/registry.py:1
- There's a grammatical error in the caption text. It should be 'more details are in the NeMAR documentation' or 'more details available in the NeMAR documentation'.
from __future__ import annotations
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
No description provided.