Skip to content

Comments

Fix documentation inconsistencies with codebase#58

Merged
rhoadesScholar merged 2 commits intomainfrom
copilot/update-readme-and-docs
Feb 19, 2026
Merged

Fix documentation inconsistencies with codebase#58
rhoadesScholar merged 2 commits intomainfrom
copilot/update-readme-and-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 19, 2026

Documentation contained outdated claims and broken references.

Changes

  • docs/source/index.rst: Removed false claim that "Functionality is not provided for writing data" - CellMapDatasetWriter exists and is documented throughout README
  • README.md: Removed broken link to non-existent docs/DATALOADER_OPTIMIZATION.md
  • README.md: Clarified pin_memory auto-enables on CUDA except Windows (matches implementation in commit 98f288c)

All code examples verified against current API.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: rhoadesScholar <37990507+rhoadesScholar@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README and documentation for accuracy Fix documentation inconsistencies with codebase Feb 19, 2026
Copilot AI requested a review from rhoadesScholar February 19, 2026 21:04
@rhoadesScholar rhoadesScholar marked this pull request as ready for review February 19, 2026 21:22
@rhoadesScholar rhoadesScholar merged commit d09f8b3 into main Feb 19, 2026
10 checks passed
@rhoadesScholar rhoadesScholar deleted the copilot/update-readme-and-docs branch February 19, 2026 21:33
@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.79%. Comparing base (98f288c) to head (b021f2e).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #58   +/-   ##
=======================================
  Coverage   68.79%   68.79%           
=======================================
  Files          27       27           
  Lines        2532     2532           
=======================================
  Hits         1742     1742           
  Misses        790      790           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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