search

napari / docs

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

Inlcude docstring of `make_napari_viewer` in `testing.md` #378

Closed lucyleeow closed 3 months ago

lucyleeow commented 3 months ago

References and relevant issues

Towards https://github.com/napari/docs/issues/150 Depends on https://github.com/napari/napari/pull/6774

Description

Use autofunction to include docstring of make_napari_viewer

lucyleeow commented 3 months ago

I think this is ready for review now. I tried to not include the full module path to make_napari_viewer but I couldn't figure out how to do this in just this instance. It's probably fine that the full path is rendered:

image

Czaki commented 3 months ago

I think that we should more promote make_napari_viewer_proxy as it will provide wrapped viewer, same as will be passed to plugins widgets.

lucyleeow commented 3 months ago

Thanks @psobolewskiPhD , changes made!

@Czaki so this testing section is aimed at napari developers, there is a separate section on testing for plugin developers. Are you recommending make_napari_viewer_proxy to be used for plugin testing or napari testing?

I will make another PR to add cross references to other testing sections.

lucyleeow commented 3 months ago

No thank you for your patience!

I just added a empty line at the end of the note because I thought the code block looked weird otherwise. Good to go if you're happy.

image

psobolewskiPhD commented 3 months ago

I think the spacing/padding/margin -- if I am understanding correctly -- is fixed in the theme: https://github.com/napari/napari-sphinx-theme/issues/100 But probably not released.

lucyleeow commented 3 months ago

I think the spacing/padding/margin -- if I am understanding correctly -- is fixed in the theme:

@psobolewskiPhD in that case I am happy to remove the empty line? I did notice there are other places with similar situation, so we may as well be consistent with what is happening already.

psobolewskiPhD commented 3 months ago

❤️ Let's wait for the release and then re-assess.