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.

Sign up for GitHub

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

Jump to bottom

Need better documentation #72

Open

leofang opened this issue Jan 28, 2020 · 1 comment

Milestone

Contributor

leofang commented Jan 28, 2020

This includes at least

docstrings for GUI functions
- thoughts: most GUI methods are considered "private" in the sense that we are free to make changes to them as long as the effects are obvious to users. Users click buttons, not call the methods, after all.
document or note for how new functions are added
- pyqt style file and auto-gen script
- main GUI class
- interface class
- backend
cleanup to reduce future maintenance burden

This needs to be resolved soon so that when I am unavailable or stepping down from the maintainer role, @mrakitin or @LonglonWu can take over.

Contributor Author

leofang commented Feb 11, 2020

Need text descriptions for GUI elements: When the cursor hovers over buttons or input fields, currently only a few items pop up a text instruction. We should make it more self-explained and so user-friendly.

leofang added this to the v1.5.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment