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

Add more info to docstring of generated methods #7

Open
AGlass0fMilk opened this issue May 27, 2019 · 0 comments
Open

Add more info to docstring of generated methods #7

AGlass0fMilk opened this issue May 27, 2019 · 0 comments

Comments

@AGlass0fMilk
Copy link

It would be useful for user clarity and tooltip generation in the lv_gui_builder if the docstring of generated methods had more information.

For example, right now, calling:

import inspect
import lvgl
inspect.getdoc(lvgl.Btn.set_auto_realign)

will print 'void lv_obj_set_auto_realign(lv_obj_t *obj, bool en)'. This is a good start. Perhaps this info could be formatted in such a way that it could be both human and machine-readable. A simple dictionary would do:

signature: void lv_obj_set_auto_realign(lv_obj_t *obj, bool en)
help: Enable autorealignment for this lvgl object

or something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant