Inlcude docstring of make_napari_viewer in testing.md
#378
Conversation
github-actions
bot
added
the
documentation
lucyleeow
changed the title
make_napari_viewer in testing.md
|
I think this is ready for review now.
|
| > note: fixtures in pytest can be a little mysterious, since it's not always | ||
| > clear where they are coming from. In this case, using a pytest-qt fixture | ||
| > looks like this: |
There was a problem hiding this comment.
Could we make this a proper admonition? It kinda looks like a code block.
I think this is actually pretty important, especially when learning, so a proper admonition would make it stand out more.
There was a problem hiding this comment.
and in the admonition i'd put the python module name pytest-qt in backticks.
There was a problem hiding this comment.
Will do and I've added that pytest-qt is a napari testing dependency.
|
I think that we should more promote |
|
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 I will make another PR to add cross references to other testing sections. |
|
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.
|
|
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. |
|
❤️ |
# References and relevant issues Follow on from #378 Depends on #325 # Description Add cross reference to other testing info in `testing.md` (waiting on #325 so I can add cross ref label) --------- Co-authored-by: Peter Sobolewski <[email protected]>
References and relevant issues
Towards #150
Depends on napari/napari#6774
Description
Use
autofunctionto include docstring ofmake_napari_viewer