Skip to content

CAN-29: Fix docstring and type hints#19

Merged
kyoung73 merged 2 commits intomainfrom
CAN-29
Feb 23, 2026
Merged

CAN-29: Fix docstring and type hints#19
kyoung73 merged 2 commits intomainfrom
CAN-29

Conversation

@kyoung73
Copy link
Copy Markdown
Contributor

@kyoung73 kyoung73 commented Feb 5, 2026

No description provided.

@kyoung73 kyoung73 requested review from alexatSL and Copilot February 5, 2026 19:03
@kyoung73 kyoung73 self-assigned this Feb 5, 2026
@kyoung73 kyoung73 added the documentation Improvements or additions to documentation label Feb 5, 2026
Copy link
Copy Markdown
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 fixes type hints throughout the codebase by replacing incorrect parentheses-based type syntax with proper square bracket syntax, and updates docstrings to follow consistent NumPy-style formatting.

Changes:

  • Fixed type hint syntax from Dict(str, List) to Dict[str, List] and similar corrections across multiple files
  • Standardized docstrings to NumPy format with proper Parameters/Returns sections
  • Corrected spelling errors in comments and docstrings
  • Updated version number from 1.2.5 to 1.2.6

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
somadata/tools/adat_concatenation.py Fixed return type hints from Dict(str, List) to Dict[str, List]
somadata/io/adat/file.py Updated type hints and docstrings, corrected example usage from Adat.from_file to read_adat
somadata/data/lift.py Added comprehensive docstrings, fixed spelling of "across", and corrected misplaced docstring
somadata/base/adat_meta_helpers.py Fixed Union type hints throughout, corrected parameter names in examples, removed duplicate example, and fixed missing closing quote
somadata/base/adat_math_helpers.py Enhanced docstring with Parameters/Returns sections and fixed spelling of "enter"
pyproject.toml Bumped version from 1.2.5 to 1.2.6

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@kyoung73 kyoung73 merged commit c670820 into main Feb 23, 2026
5 checks passed
@kyoung73 kyoung73 deleted the CAN-29 branch February 23, 2026 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants