Skip to content

Update README and pyproject.toml; enhance annotations handling and tests#16

Merged
kyoung73 merged 2 commits intomainfrom
CAN-26
Jul 15, 2025
Merged

Update README and pyproject.toml; enhance annotations handling and tests#16
kyoung73 merged 2 commits intomainfrom
CAN-26

Conversation

@kyoung73
Copy link
Copy Markdown
Contributor

  • Updated README.md to improve badge visibility and added GitHub actions and issues badges.
  • Bumped version in pyproject.toml to 1.2.4 and updated deprecated fields.
  • Enhanced Annotations class to check for 'SeqId' in both index and columns.
  • Added new test cases for handling SeqId in annotations lifting.
  • CAN-26

- Updated README.md to improve badge visibility and added GitHub actions and issues badges.
- Bumped version in pyproject.toml to 1.2.4 and updated authors and dependencies.
- Enhanced Annotations class to check for 'SeqId' in both index and columns.
- Added new test cases for handling SeqId in annotations lifting.
- CAN-26
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

Enhance project metadata, documentation, and annotations handling to support SeqId in both index and columns, and expand tests accordingly.

  • Improve README badges and remove deprecated anchors.
  • Migrate pyproject.toml to PEP 621-style metadata, bump version to 1.2.4, and update dependencies.
  • Extend Annotations.update_adat_column_meta and Annotations.lift_adat to detect SeqId in either index or columns, with new tests covering the scenarios.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
tests/test_annotation_lifting.py Refactored test helpers, added constants, and new test cases for SeqId in index/columns
somadata/annotations.py Added SeqId presence checks in both index and columns for updating metadata and lifting
pyproject.toml Converted to [project] table format, bumped version, added requires-python and dependencies
README.md Updated badges and cleaned up redundant “return to top” anchors
Comments suppressed due to low confidence (2)

tests/test_annotation_lifting.py:23

  • [nitpick] The parameter index_col accepts both False and a column name string, which can be confusing. Consider renaming it to index_label or index_name to clarify its purpose.
def create_annotations_from_csv(csv_data: str, index_col=False) -> Annotations:

README.md:109

  • [nitpick] There are several 'return to top' links scattered throughout this document. Consider consolidating or removing redundant anchors to improve readability.
[return to top](#toptoc)

@kyoung73 kyoung73 merged commit e9d4b99 into main Jul 15, 2025
5 checks passed
@kyoung73 kyoung73 deleted the CAN-26 branch July 15, 2025 16:55
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.

3 participants