python / python/cpython

io.BufferedRWPair doc warning may need clarification

Ouverte
#82,776 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.7 (EOL) docs topic-IO type-bug
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

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']

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner la documentation de io.BufferedRWPair et l’issue BPO migrée 38595, y compris ses deux commentaires. Repérez l’avertissement mentionné par l’issue et déterminez quelle clarification est nécessaire ; le travail est terminé lorsque la documentation pertinente explique clairement cet avertissement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
28/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.