Include IDE annotations for all internal functions

See original GitHub issue

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.

Issue Analytics

State:
Created 3 years ago
Comments:6 (6 by maintainers)

Top GitHub Comments

1reaction

Mohan-cloudcommented, Jun 14, 2021

Thanks @PabloLec, I will contact you! 😁

0reactions

PabloLeccommented, Jun 14, 2021

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, pablolec@pm.me 😉

Top Results From Across the Web

Annotations | IntelliJ IDEA Documentation - JetBrains

Java annotations are pieces of metadata that provide information about the code they are used with, and can instruct the IDE how to...

An Introduction to Annotations and Annotation Processing in ...

Annotations provide information to a program at compile time or at runtime based on which the program can take further action.

typing — Support for type hints — Python 3.11.1 documentation

Introducing syntax for annotating variables outside of function definitions, and ClassVar ... A generic type can have any number of type variables.

Improve code inspection with annotations - Android Developers

Note: If a module has a dependency on an annotation processor, you must use the `annotationProcessor` dependency configuration to add that dependency. To...

Understanding type annotation in Python - LogRocket Blog

When to use the Iterable type to annotate function parameters ... This option flags functions that don't have all of their parameters and ......