Skip to content
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

Include IDE annotations for all internal functions #77

Open
14 tasks
jwlodek opened this issue Jan 9, 2021 · 6 comments
Open
14 tasks

Include IDE annotations for all internal functions #77

jwlodek opened this issue Jan 9, 2021 · 6 comments
Labels
Debug Add for issues pertaining to debug options (logging) Feature Request Add for a new feature request Good first issue Good for newcomers Help wanted Extra attention is needed
Milestone

Comments

@jwlodek
Copy link
Owner

jwlodek commented Jan 9, 2021

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.

@jwlodek jwlodek added Help wanted Extra attention is needed Good first issue Good for newcomers Feature Request Add for a new feature request Debug Add for issues pertaining to debug options (logging) labels Jan 9, 2021
@jwlodek jwlodek added this to the v0.2.0 milestone Jan 9, 2021
@jupiterbjy
Copy link
Contributor

jupiterbjy commented Feb 7, 2021

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.

@Mohan-cloud
Copy link
Contributor

Hi. I would like to work on this as a first issue. Is anyone else working on this?

@jwlodek
Copy link
Owner Author

jwlodek commented Jun 14, 2021

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

@Mohan-cloud
Copy link
Contributor

Alright! I would need some help from you moving forward as I have not done this before.

@PabloLec
Copy link
Contributor

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] 😉

@Mohan-cloud
Copy link
Contributor

Thanks @PabloLec, I will contact you! 😁

@Mohan-cloud Mohan-cloud mentioned this issue Jun 21, 2021
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Debug Add for issues pertaining to debug options (logging) Feature Request Add for a new feature request Good first issue Good for newcomers Help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants