python / python/cpython

Documentation for `PYTHONUNBUFFERED` is not correct

Abierto
#128,392 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Documentation

Follow up on: https://github.com/python/cpython/issues/128377

According to docs, PYTHONUNBUFFERED is true if set as a non-empty string. Setting it to "0" (which is non-empty string) has effect of disabling it though.
Related C code:
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/initconfig.c#L1786-L1790
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/preconfig.c#L563-L578
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/preconfig.c#L545-L560

We should probably rephrase it from:
If this is set to a non-empty string...
to:
If this is set...

Linked PRs
  • gh-128393

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Abre la entrada PYTHONUNBUFFERED en la documentación de las variables de entorno de la línea de comandos de Python y compara su redacción con la lógica citada en Python/initconfig.c y Python/preconfig.c. Actualiza la descripción para que refleje con precisión el comportamiento documentado y, después, verifica la redacción resultante de la documentación; ten en cuenta que el PR enlazado gh-128393 indica que el trabajo ya está en curso.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.