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

Missing Documentation - I/O behaviour #157

Open
NightKhaos opened this issue Dec 7, 2024 · 0 comments
Open

Missing Documentation - I/O behaviour #157

NightKhaos opened this issue Dec 7, 2024 · 0 comments

Comments

@NightKhaos
Copy link

Background

At the moment it is difficult to jump right into a PyScript project and understand what the behavior of some things will be. For example, if I use print or the the logging module without any configuration, it would be helpful to know where the print statements will end up writing. With some context it is clear that the behaviour can differ depending on if the terminal is active.

Problem

The documentation does not explain basic I/O behaviors of common outputs like logging or print. A developer may expect anything printed to go to the web console. It's only through testing that they find out that the if you write to stderr or submit a logger.error message via the Python Logging library that you will observe that a div will be added to the document of class py-error, and if you want to disable or overwrite this behaviour you need to refer to the error plugin (see #156).

Proposal

Create a section that explains how Python IO and logging maps into the web console and other features, like the error plugin.

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