python / python/cpython

Misleading documentation for NotImplemented

Offen
#83,292 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 39111
Nosy @stevendaprano, @Murali

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-12-20.16:42:56.150>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Misleading documentation for NotImplemented'
updated_at = <Date 2019-12-28.07:11:38.640>
user = 'https://github.com/Murali'

bugs.python.org fields:

activity = <Date 2019-12-28.07:11:38.640>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-12-20.16:42:56.150>
creator = 'murali'
dependencies = []
files = []
hgrepos = []
issue_num = 39111
keywords = []
message_count = 5.0
messages = ['358719', '358722', '358723', '358726', '358752']
nosy_count = 3.0
nosy_names = ['steven.daprano', 'docs@python', 'murali']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39111'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Überprüfung der NotImplemented-Dokumentation und des verlinkten BPO-Issues 39111, um festzustellen, welche Formulierung irreführend ist. Der Issue-Payload nennt keine Datei, keinen Test und keine konkrete Korrektur; bestätige daher die beabsichtigte Dokumentationsänderung vor dem Bearbeiten und überprüfe, dass der überarbeitete Text NotImplemented korrekt beschreibt.

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
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.