python / python/cpython

Need reST markup for enum types

Offen
#73,787 4 Kommentare 0 Reaktionen 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 29601
Nosy @freddrake, @warsaw, @berkerpeksag

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-02-19.17:08:14.768>
labels = ['3.7', 'docs']
title = 'Need reST markup for enum types'
updated_at = <Date 2017-02-20.00:13:44.715>
user = 'https://github.com/warsaw'

bugs.python.org fields:

activity = <Date 2017-02-20.00:13:44.715>
actor = 'barry'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-02-19.17:08:14.768>
creator = 'barry'
dependencies = []
files = []
hgrepos = []
issue_num = 29601
keywords = []
message_count = 3.0
messages = ['288147', '288167', '288168']
nosy_count = 4.0
nosy_names = ['fdrake', 'barry', 'docs@python', 'berker.peksag']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue29601'
versions = ['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

Das Issue identifiziert Python-Dokumentation und fordert reST markup für enum types an, nennt jedoch keine Datei und keinen Test. Beginne mit der Überprüfung des verlinkten BPO issue und durchsuche die Dokumentation nach Referenzen auf enum types. Als erledigt gilt die Aufgabe, wenn die betroffene Dokumentation das angeforderte reST markup verwendet und die relevanten Dokumentationsprüfungen erfolgreich sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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