search

napari / napari

napari: a fast, interactive, multi-dimensional image viewer for python
https://napari.org
BSD 3-Clause "New" or "Revised" License
2.09k stars 411 forks source link

Expose NotebookScreenshot docstring #6833

Closed melissawm closed 1 month ago

melissawm commented 1 month ago

References and relevant issues

Closes napari/docs#376

Description

Exposes the docstring of NotebookScreenshot, which now apppears as a link in the nbscreenshot docstring.

I understand NotebookScreenshot may not be something we want to expose. In that case, I would suggest moving the docstring to nbscreenshot as an alternative.

Also fixes a few syntax errors in the NotebookScreenshot docstring.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.39%. Comparing base (4b9ed3f) to head (5fb6c21). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6833 +/- ## ========================================== - Coverage 92.44% 92.39% -0.06% ========================================== Files 615 615 Lines 54911 54912 +1 ========================================== - Hits 50765 50736 -29 - Misses 4146 4176 +30 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

psobolewskiPhD commented 1 month ago

Here's the rendered html: https://output.circle-artifacts.com/output/job/ca65b81d-f8d8-4645-8d3b-d88d5af2d532/artifacts/0/docs/docs/_build/html/api/napari.utils.NotebookScreenshot.html