search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
9 stars 37 forks source link

[API] the API docs for napari.utils.nbscreenshot are empty #376

Closed psobolewskiPhD closed 2 months ago

psobolewskiPhD commented 3 months ago

🐛 Bug

napari.utils.nbscreenshot is in the API docs, but it's actually an alias to NotebookScreenshot There is no documentation for nbscreenshot: https://napari.org/stable/api/napari.utils.nbscreenshot.html image

Meanwhile NotebookScreenshot has a very nice and helpful doctstring, complete with example: https://github.com/napari/napari/blob/705c30768cbed43ea3d8a0cad4af1b6f1190fbc2/napari/utils/notebook_display.py#L20-L49

Environment

stable (0.4.19) and latest

psobolewskiPhD commented 3 months ago

Hmm, is the solution to add NotebookScreenshot import to the init? https://github.com/napari/napari/blob/705c30768cbed43ea3d8a0cad4af1b6f1190fbc2/napari/utils/__init__.py#L11-L22

cc: @melissawm

melissawm commented 3 months ago

Let me take a look - this is probably not the only instance of this kind of missing content