Missing Documentation - I/O behaviour
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Review the existing error plugin documentation referenced by #156 and the documentation structure for an appropriate place to add the section. Explain how print, stderr, and Python logging appear with and without the terminal, including the py-error behavior and how the error plugin changes it.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 17
- Fork
- 20
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pyscript/docs
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 68/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 32/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
Tutte le issue di pyscript/docs
Issue simili
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
canonical/paas-charm#368 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
tech debt
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
addition to tracking list Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
StevenBlack/hosts#3256 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
qualcomm/qai-appbuilder#275 ·