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

Fix and improve doc on Gui.__init__ #1204

Open
FlorianJacta opened this issue Nov 15, 2024 · 0 comments
Open

Fix and improve doc on Gui.__init__ #1204

FlorianJacta opened this issue Nov 15, 2024 · 0 comments
Labels
📄 Documentation Internal or public documentation 🖰 GUI Related to GUI 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon

Comments

@FlorianJacta
Copy link
Member

From a user:

The documentation of Gui.init(), specifically concerning parameter env_filename, could use a couple of fixes:

  1. The table's default column has None listed, but in the description it notes that the default = taipy.gui.env.
  2. Additional explanation that the env_filename will ALWAYS override over any passed kwargs in run(). To the end user this is very unclear. Without an explanation, one would logically expect that the following code would use the kwargs passed to run():
app = Gui(pages=pages, env_filename='taipy.gui.env') # containing run_browser=True
if __name__ == '__main__':
    app.run(run_browser=False)

image

In reality, the browser settings are overridden by the env-file.

Debugging this was especially difficult without knowing that the default of env_filename is taipy.gui.env, and that app = Gui() was in fact still loading the env-file

@FlorianJacta FlorianJacta added 📈 Improvement Improvement of a feature. 🖰 GUI Related to GUI 📄 Documentation Internal or public documentation 🟨 Priority: Medium Not blocking but should be fixed soon labels Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation 🖰 GUI Related to GUI 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon
Projects
None yet
Development

No branches or pull requests

1 participant