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

[h-mayorquin]

What would you like changed or added to the documentation and why?

This works on my system:

from pynwb.image import Images

But the object is not found in the images API:

https://pynwb.readthedocs.io/en/stable/pynwb.image.html

Instead, it is found on base:

https://pynwb.readthedocs.io/en/stable/pynwb.base.html#pynwb.base.Images

It makes sense to me that it should be on Images as I would look for that but maybe it should be duplicated to be here and in base?

Should pynwb.base be internal?

I guess slightly related to #1686

Do you have any interest in helping write or edit the documentation?

No.

Code of Conduct

• I agree to follow this project's Code of Conduct
• Have you checked the Contributing document?
• Have you ensured this change was not already requested?

[stephprince]

It looks like Images was added to pynwb.base originally (#693) and reflects the structure of the schema: nwb.base.yaml.

@rly or @bendichter can you comment on @h-mayorquin's questions?

[bendichter]

@h-mayorquin how about this?

[h-mayorquin]

I think the list/summary at the top of pynwb.Image looks great. It addresses the case of someone looking for Images in pynwb.image and not finding it there.