Skip to content

Conversation

@bruAristimunha
Copy link
Collaborator

No description provided.

@bruAristimunha bruAristimunha changed the title Improving API doc html page [DOC] Improving API doc html page Sep 27, 2025
Copy link
Contributor

Copilot AI left a 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.

@bruAristimunha bruAristimunha merged commit bebf509 into develop Sep 27, 2025
8 checks passed
@bruAristimunha bruAristimunha deleted the documentation branch September 27, 2025 19:13
@bruAristimunha bruAristimunha restored the documentation branch September 27, 2025 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants