python / python/cpython

Viewing pydoc API documentation

Offen
#86,876 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 42710

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 2020-12-22.04:26:31.062>
labels = ['docs']
title = 'Viewing pydoc API documentation'
updated_at = <Date 2020-12-22.04:26:31.062>
user = 'https://bugs.python.org/FarisChugthai'

bugs.python.org fields:

activity = <Date 2020-12-22.04:26:31.062>
actor = 'Faris Chugthai'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-22.04:26:31.062>
creator = 'Faris Chugthai'
dependencies = []
files = []
hgrepos = []
issue_num = 42710
keywords = []
message_count = 1.0
messages = ['383570']
nosy_count = 2.0
nosy_names = ['docs@python', 'Faris Chugthai']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42710'
versions = []

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

Der Issue enthält nur den Titel und migrierte Tracker-Metadaten; es wird keine Datei, kein Test und kein Einstiegspunkt genannt. Kläre zunächst, welche Änderung für die Anzeige der pydoc API-Dokumentation gewünscht ist und welches Dokumentations- oder pydoc-Verhalten im Umfang liegt. Als abgeschlossen sollte eine vereinbarte Anforderung und eine entsprechende Dokumentationsänderung oder ein verifiziertes Verhalten definiert sein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

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