-
Notifications
You must be signed in to change notification settings - Fork 12
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
Add documentation for webactions and enhance production tracker docs #287
Conversation
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.
Awesome stuff 💯
entity_type="folder", | ||
entity_subtypes=None, |
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.
I recall - as I tried to implement these - being quite confused about what combinations of values this support. Should we document that clearer somewhere (either in the code somewhere, or here?)
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.
@martastain
TL;DR
This PR adds draft/initial docs for implementing web actions. Also, I've added an example web action.
My question: Do you have any recommendations for extending the current initial docs?
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.
I'm personally fine with it staying as is - just saying that it'd be nice to get this clarified over time because it's where I got lost.
@MustafaJafar this is never going to get approved by everyone, probably better to merge now and improve later? |
yeah, let's merge it. |
![](assets/addon_dev/web_action_example.png) | ||
|
||
```python title="my_addon/client/my_addon/__init__.py" | ||
from qtpy import QtWidgets |
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.
It's too late, but Qt (or any other runtime dependency) should never be imported in addon...
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.
This is not the only example that imports QT in addon 😅
e.g. I did the same in the tray example
For reference, should it be imported inside the function like here?
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.
For reference, should it be imported inside the function like here?
Yes, usually by importing Qt it in the function, or by importing file that has Qt implementation inside the function.
Changelog Description
resolve #252
This PR adds:
Testing notes: