Clearer wording of os.WNOHANG documentation to avoid misinterpretation
Offen
Dieses Issue hat noch niemand übernommen.
3.7 (EOL)
3.8 (EOL)
3.9 (EOL)
docs
stdlib
type-feature
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
| 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']
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die vorhandene Dokumentation zu os.WNOHANG in der Python-Bibliotheksdokumentation zu finden, und lies die umgebende Erklärung sowie den Nutzungskontext. Überarbeite die Formulierung so, dass ihr Verhalten nicht missverstanden werden kann, und überprüfe anschließend, dass die Dokumentation die beabsichtigte Bedeutung klar vermittelt und die Dokumentationsprüfungen des Projekts besteht.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100