python / python/cpython

Automate adding Type Annotations to Documentation

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

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

BPO 39204
Nosy @gvanrossum, @brettcannon, @rhettinger, @ilevkivskyi, @cooperlees, @pablogsal, @tirkarthi

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-01-03.19:12:25.475>
labels = ['type-feature', 'library', '3.9']
title = 'Automate adding Type Annotations to Documentation'
updated_at = <Date 2020-01-10.18:56:07.158>
user = 'https://github.com/cooperlees'

bugs.python.org fields:

activity = <Date 2020-01-10.18:56:07.158>
actor = 'levkivskyi'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2020-01-03.19:12:25.475>
creator = 'cooperlees'
dependencies = []
files = []
hgrepos = []
issue_num = 39204
keywords = []
message_count = 6.0
messages = ['359249', '359274', '359275', '359276', '359446', '359449']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'brett.cannon', 'rhettinger', 'levkivskyi', 'cooperlees', 'pablogsal', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39204'
versions = ['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

Im Issue sind keine Quelldateien, Tests oder Einstiegspunkte angegeben. Beginne mit der Prüfung des verlinkten BPO-Issues und des Workflows für die Python-Bibliotheksdokumentation, um festzulegen, wie Annotationen erkannt und dargestellt werden sollen; abgeschlossen ist die Arbeit, wenn der Prozess Typannotationen automatisch zur Dokumentation hinzufügt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
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.