python / python/cpython

Cmd.onecmd documentation is misleading

Offen
#76,464 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.7 (EOL) stdlib
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 32283

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 2017-12-12.00:20:54.862>
labels = ['3.7', 'library']
title = 'Cmd.onecmd documentation is misleading'
updated_at = <Date 2017-12-12.00:20:54.862>
user = 'https://bugs.python.org/lyda'

bugs.python.org fields:

activity = <Date 2017-12-12.00:20:54.862>
actor = 'lyda'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-12-12.00:20:54.862>
creator = 'lyda'
dependencies = []
files = []
hgrepos = []
issue_num = 32283
keywords = []
message_count = 1.0
messages = ['308082']
nosy_count = 1.0
nosy_names = ['lyda']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32283'
versions = ['Python 3.6', 'Python 3.7']

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 damit, die Bibliotheksdokumentation für Cmd.onecmd zu finden, und vergleiche ihre Formulierung mit dem dokumentierten Verhalten. Das Issue nennt keine Datei und erklärt nicht, welcher Text irreführend ist; ermittle daher die erforderliche Klarstellung vor der Bearbeitung; abgeschlossen bedeutet, dass die Dokumentation Cmd.onecmd korrekt beschreibt und die Dokumentationsprüfungen erfolgreich sind.

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
25/100

Neue Issues direkt in Ihr Postfach

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