Clarify optionality of type annotations for writing a plugin#367
Clarify optionality of type annotations for writing a plugin#367psobolewskiPhD merged 13 commits intonapari:mainfrom
Conversation
|
I would move this up to the 'The LayerData tuple' section even. Something like: The syntax at the end adds a link to the relevant widget section of the docs. I've checked with Draga and there are no other places annotation is required for npe2, and I think it is not ever required for npe1 but I will confirm this! Edit - yeah I think never req for npe1. |
Thanks @lucyleeow , I'd wanted to add this but wasn't quickly sure of exactly the right link reference |
|
@lucyleeow I took (as I understood it -- hopefully correctly) your suggestion about placement within the doc for this new text, and your idea to link to the |
lucyleeow
left a comment
There was a problem hiding this comment.
Could you also add strings (or imports if you feel this is better) to the reader plugin code snippet too? Thank you!
Yeah not 100% sure I see the right edit, but I gave a shot here: napari/npe2#340 |
|
Ah yes I forgot our docs are spread out across 3 repos and are complicated 🤦 . I'll take a look! |
Co-authored-by: Lucy Liu <jliu176@gmail.com>
Co-authored-by: Lucy Liu <jliu176@gmail.com>
c8c65df to
bf3c391
Compare
27e7a90 to
ae13166
Compare
Co-authored-by: Lucy Liu <jliu176@gmail.com>
lucyleeow
left a comment
There was a problem hiding this comment.
Looks good, thank you!
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
) napari/docs#367 (review) napari/docs#365 --------- Co-authored-by: Draga Doncila Pop <17995243+DragaDoncila@users.noreply.github.com>
This would close #365 by making more explicit the optionality of type annotations when writing a plugin, and adding a general note about their utility in the doc.