-
Notifications
You must be signed in to change notification settings - Fork 16
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
List and discuss the name for the plugin design #496
Comments
During @superstar54's group meeting, we agreed that we release this |
Pining @AndresOrtegaGuerrero @PNOGillespie @mikibonacci who start implement the plugins, do you find some class names are not clear or bring ambiguity? If those are all fine, we can close this PR. |
Hi @unkcpz, I do not have in mind examples, so for me everything is fine |
Hi @unkcpz, the one thing that occurs to me is that On the one hand, the documentation for the plugin system states:
On the other hand, the docstring for
My suggestion is just to make sure the docstrings and documentation agree with each other, so that it's clear in both places what each part is meant to do. Changing the name of Other than that however, the rest of the system was clear enough for me to work with. |
Thanks @mikibonacci @PNOGillespie for the feedback. @superstar54 Can you keep track on this issue and make sure the advice from @PNOGillespie above is happened on the |
Thanks to the great work contributed by @superstar54, the plugin design allows new property developers can focus on the functionality and widgets needed for the property itself without knowledge of how other part of QeApp works.
It decouples the settings of parameters of different calculations by introducing the "Panel" as the base widget class which has some common functionality to interact with other parts of the code.
There are some terminology and methods used but not intuitively straightforward to know what is for, such as "identifier", "get_panel_value" etc.
@superstar54, can you make a list of these names and we can have a discussion with @giovannipizzi? Once we make the stable release at the end of this month, it become a new API for developers and will be hard to change after.
The text was updated successfully, but these errors were encountered: