Skip to content
New issue

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

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

Already on GitHub? # to your account

Add documentation of make_napari_viewer and DynamicPlugin #150

Open
Czaki opened this issue May 7, 2023 · 7 comments
Open

Add documentation of make_napari_viewer and DynamicPlugin #150

Czaki opened this issue May 7, 2023 · 7 comments
Labels
content Ideas for new or improved content task

Comments

@Czaki
Copy link
Contributor

Czaki commented May 7, 2023

🧰 Task

When preparing a response to napari/napari#5810 I found that We do not have documentation for arguments of the make_napari_viewer fixture factory and napari_plugin_manager fixture.

It should be added to Testing section of documentation https://napari.org/stable/developers/testing.html

@lucyleeow
Copy link
Collaborator

lucyleeow commented Mar 13, 2024

The make_napari_viewer fixture has a decent docstring (recent improvements have been added). I think copying the info from the docs to the documentation would be useful. In our docs we do mention make_napari_viewer but a lot of useful information from the docstring is not included.

I could just copy it across but to ease future maintenance, maybe we could do something more clever, some kind of include or whatever is happening with the plugins contribution docs?

@lucyleeow
Copy link
Collaborator

I think napari_plugin_manager is now outdated but we should document the DynamicPlugin fixture, related issue see: #321 (comment)

@lucyleeow lucyleeow added the content Ideas for new or improved content label Mar 13, 2024
@jaimergp
Copy link
Contributor

napari_plugin_manager the name here is also confusing given how napari/napari-plugin-manager uses that as the Python package name. By "outdated", is there a change you mean "marked for deprecation"? 😬

@lucyleeow
Copy link
Collaborator

Yes very confusing.

By "outdated", is there a change you mean "marked for deprecation"? 😬

Yes, napari_plugin_manager is a testing fixture for npe1 plugin manager. Hopefully one day npe1 will be deprecated.... 😬

@lucyleeow
Copy link
Collaborator

lucyleeow commented Mar 25, 2024

@psobolewskiPhD could we amend the title: napari_plugin_manager -> DynamicPlugin (I don't have rights)
Note you can get the npe2 pm via DynamicPlugin.plugin_manager.

@psobolewskiPhD psobolewskiPhD changed the title Add documentation of make_napari_viewer and napari_plugin_manager Add documentation of make_napari_viewer and DynamicPlugin Mar 26, 2024
@psobolewskiPhD
Copy link
Member

@lucyleeow Did I do it correctly?

@lucyleeow
Copy link
Collaborator

Yes thank you! 🙏

GenevieveBuckley pushed a commit to napari/napari that referenced this issue Mar 26, 2024
# References and relevant issues
napari/docs#150

# Description
I would like to include the docstring of `make_napari_viewer` in the
docs (so we don't need to update in 2 places). This adds info from the
[docs](https://napari.org/dev/developers/contributing/testing.html#testing-with-qt-and-napari-viewer)
to the docstring. I can then include just the docstring in the docs.
psobolewskiPhD pushed a commit that referenced this issue Mar 27, 2024
# References and relevant issues
Towards #150
Depends on napari/napari#6774

# Description
Use `autofunction` to include docstring of `make_napari_viewer`
@melissawm melissawm moved this to Prioritized in Documentation Working Group Jul 8, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
content Ideas for new or improved content task
Projects
Status: Prioritized
Development

No branches or pull requests

4 participants