Skip to content

Conversation

@ehennestad
Copy link
Collaborator

@ehennestad ehennestad commented Nov 4, 2025

Motivation

Improve documentation:

  • Add missing function and class references for nwbRead / NwbFile
  • Update information box on lazy reading in "Reading NWB Files" section to focus more on files
  • Improve explanation sections for DataStubs and DataPipes

Link to docs

How to test the behavior?

N/A

Checklist

  • Have you ensured the PR description clearly describes the problem and solutions?
  • Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

Changed the reference to nwbRead from inline code to Sphinx function markup (:func:`nwbRead`)
Changed the reference to the returned NwbFile object from inline code to Sphinx's :class: directive.
Updated the description of lazy loading in MatNWB to clarify that only file structure and metadata are loaded initially when reading an NWB file. The new explanation emphasizes efficient handling of large files and directs users to the DataStubs and DataPipes section for details on loading dataset contents.
The untyped utility types documentation now provides detailed explanations of DataStubs and DataPipes, including their roles in efficient data access and writing for large NWB datasets. Key characteristics, usage scenarios, and references to further tutorials have been added for clarity.
@ehennestad ehennestad marked this pull request as ready for review November 4, 2025 20:22
@ehennestad ehennestad requested a review from bendichter November 4, 2025 20:22
PR requires tests to pass, so tests should always run on PR
@codecov
Copy link

codecov bot commented Nov 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.59%. Comparing base (6cb513a) to head (e11b3f8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #769   +/-   ##
=======================================
  Coverage   95.59%   95.59%           
=======================================
  Files         184      184           
  Lines        6443     6443           
=======================================
  Hits         6159     6159           
  Misses        284      284           

☔ 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.

@ehennestad ehennestad merged commit 24f8b44 into main Nov 5, 2025
18 checks passed
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