-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify optionality of type annotations for writing a plugin #367
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Co-authored-by: Lucy Liu <[email protected]>
Co-authored-by: Lucy Liu <[email protected]>
c8c65df
to
bf3c391
Compare
27e7a90
to
ae13166
Compare
Co-authored-by: Lucy Liu <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thank you!
Co-authored-by: Peter Sobolewski <[email protected]>
) napari/docs#367 (review) napari/docs#365 --------- Co-authored-by: Draga Doncila Pop <[email protected]>
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.