python / python/cpython

Clearer wording of os.WNOHANG documentation to avoid misinterpretation

Aperta
#82,983 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs stdlib type-feature
Lingua principale
Python
Stelle
77.2k
Fork
36k
Merge medio
1g 9h
PR unite (30g)
558

Descrizione

BPO 38802
Nosy @iritkatriel

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-11-14.21:52:21.080>
labels = ['3.7', '3.8', '3.9', 'type-feature', 'library', 'docs']
title = 'Clearer wording of os.WNOHANG documentation to avoid misinterpretation'
updated_at = <Date 2021-06-24.23:45:41.286>
user = 'https://bugs.python.org/bbmmy'

bugs.python.org fields:

activity = <Date 2021-06-24.23:45:41.286>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2019-11-14.21:52:21.080>
creator = 'bbmmy'
dependencies = []
files = []
hgrepos = []
issue_num = 38802
keywords = []
message_count = 3.0
messages = ['356627', '356628', '396517']
nosy_count = 3.0
nosy_names = ['docs@python', 'bbmmy', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38802'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9']

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando la documentazione esistente di os.WNOHANG nella documentazione della libreria Python e leggendo la spiegazione circostante e il contesto di utilizzo. Rivedi la formulazione in modo che il suo comportamento non possa essere frainteso, quindi verifica che la documentazione esprima chiaramente il significato previsto e superi i controlli della documentazione del progetto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.