python / python/cpython

Documentation for `PYTHONUNBUFFERED` is not correct

Aberta
#128,392 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Abra a entrada PYTHONUNBUFFERED na documentação das variáveis de ambiente da linha de comando do Python e compare sua redação com a lógica citada em Python/initconfig.c e Python/preconfig.c. Atualize a descrição para que ela reflita com precisão o comportamento documentado e, em seguida, verifique a redação resultante da documentação; observe que o PR vinculado gh-128393 indica que o trabalho já está em andamento.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.