Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Images in image mod docs #2029

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Images in image mod docs #2029

wants to merge 4 commits into from

Conversation

bendichter
Copy link
Contributor

fix #2022

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.78%. Comparing base (5564f82) to head (e622cff).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #2029   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files          27       27           
  Lines        2738     2738           
  Branches      709      709           
=======================================
  Hits         2513     2513           
  Misses        149      149           
  Partials       76       76           
Flag Coverage Δ
integration 73.15% <ø> (ø)
unit 82.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@rly rly requested a review from stephprince February 20, 2025 22:47
Comment on lines +51 to +53
# Virtual Environment
venv/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Virtual Environment
venv/

This was already added to the gitignore and duplicated when merging.

Comment on lines +16 to +17
Note: While the :class:`~pynwb.base.Image` and :class:`~pynwb.base.Images` classes are defined in :mod:`pynwb.base`, they can be imported directly from this module:
from pynwb.image import Image, Images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note: While the :class:`~pynwb.base.Image` and :class:`~pynwb.base.Images` classes are defined in :mod:`pynwb.base`, they can be imported directly from this module:
from pynwb.image import Image, Images
Note: While the :class:`~pynwb.base.Image` and :class:`~pynwb.base.Images` classes are defined in :mod:`pynwb.base`,
they can be imported directly from this module:
from pynwb.image import Image, Images

Break up line for ruff

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.

[Documentation]: Images object not present in the pynwb.image API
3 participants