Missing Documentation - I/O behaviour
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 17
- Forks
- 20
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de pyscript/docs
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 32/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 30/100
Todos los issues de pyscript/docs
Issues similares
-
essnmx good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
-
[Feature] 奇物选择添加优先级 Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
syfoud/Simulated_Scepter#174 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Giskard-AI/giskard-oss#2840 · 1 comentario ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Abiertoarea: repo bug perceived difficulty: 2
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
yeti-platform/yeti#1380 ·