search

Avaiga / taipy

Turns Data and AI algorithms into production-ready web applications in no time.
https://www.taipy.io
Apache License 2.0
10.94k stars 775 forks source link

Clarify parameters in Gui constructor and run() #452

Open FabienLelaquais opened 1 year ago

FabienLelaquais commented 1 year ago

Description

As of today, the Gui constructor and run() method have a bunch of parameters and it's not really clear why those parameters are used in one, or the other.

I suspect we should have a clear rule such as: any parameter that might make sense when the server is stopped then run again (such as in the Notebook situation) definitively should be in the run() method. Otherwise, the constructor sounds like the right place (like the server to be used).

Acceptance Criteria

rohan011001 commented 4 months ago

will be better having a Config section for GUI parameters so it is easier to configure it dynamic. And better consistent.

FlorianJacta commented 4 months ago

@rohan011001 Is this what you are referring to? configure_gui

rohan011001 commented 2 months ago

@FlorianJacta Yes exactly. Why not pushing this method in the doc. It is easier to configure dynamicly and consistent.

jrobinAV commented 1 month ago

Clarifying all the attributes and parameters of the GUI service, the run method, the GUI application, and the GuiSection should improve the user manual documentation. The "Configuration" pages could be more use-case driven. https://github.com/Avaiga/taipy-doc/pull/940/#discussion_r1680560794

jrobinAV commented 1 month ago

I am increasing the priority of the ticket because I believe it would be good to discuss the issue (at least) before the release of 4.0.