python / python/cpython

io.BufferedRWPair doc warning may need clarification

Aberta
#82,776 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

3.7 (EOL) docs topic-IO type-bug
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

BPO 38595
Nosy @pitrou, @benjaminp

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-10-26.05:19:33.715>
labels = ['type-bug', '3.7', 'docs']
title = 'io.BufferedRWPair doc warning may need clarification'
updated_at = <Date 2019-10-26.05:30:22.117>
user = 'https://bugs.python.org/rgov'

bugs.python.org fields:

activity = <Date 2019-10-26.05:30:22.117>
actor = 'rgov'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-26.05:19:33.715>
creator = 'rgov'
dependencies = []
files = []
hgrepos = []
issue_num = 38595
keywords = []
message_count = 2.0
messages = ['355404', '355405']
nosy_count = 5.0
nosy_names = ['pitrou', 'benjamin.peterson', 'stutzbach', 'docs@python', 'rgov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38595'
versions = ['Python 3.7']

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

Comece revisando a documentação de io.BufferedRWPair e a issue 38595 migrada do BPO, incluindo seus dois comentários. Localize o aviso mencionado pela issue e determine qual esclarecimento é necessário; o trabalho estará concluído quando a documentação relevante explicar claramente esse aviso.

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
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
28/100

Receba novas issues na sua caixa de entrada

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