py_cui
py_cui copied to clipboard
Include IDE annotations for all internal functions
Is your feature request related to a problem? Please describe.
Annotations for function arguments and return values could simplify development of py_cui as well as applications using it
Describe the solution you'd like Annotations should be added to all internal API functions for arguments and return types
Files that have annotations that need to be added:
- [ ] __init__.py
- [ ] widgets.py
- [ ] ui.py
- [ ] popups.py
- [ ] widget_set.py
- [ ] statusbar.py
- [ ] colors.py
- [ ] keys.py
- [ ] renderer.py
- [ ] debug.py
- [ ] grid.py
- [ ] dialogs/form.py
- [ ] dialogs/filedialog.py
- [ ] controls/slider.py
Additional context Possibly documentation auto-creation tools may need to be updated to reflect these new changes.
Should I make another issue for wrong annotations, or commenting those here?
As those are too small to make it as a individual issues or commits, I think having a list of of those and batch fixing it would be nice.
Will definitely need a public place where others can also see, so there won't be a conflicting commits.
Hi. I would like to work on this as a first issue. Is anyone else working on this?
That would be great! As far as I know there hasn't been any dedicated work toward it yet, so if you'd like to work on it it would be appreciated
Alright! I would need some help from you moving forward as I have not done this before.
Alright! I would need some help from you moving forward as I have not done this before.
I can answer some questions if you want to, [email protected] :wink:
Thanks @PabloLec, I will contact you! :grin: