python / python/cpython

Profile 'builtins' parameter documentation missing

Offen
#84,386 2 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 stdlib
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 40205
Nosy @terryjreedy, @bharel

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-04-06.14:43:33.212>
labels = ['3.8', '3.7', 'library', '3.9', 'docs']
title = "Profile 'builtins' parameter documentation missing"
updated_at = <Date 2020-04-11.01:16:06.060>
user = 'https://github.com/bharel'

bugs.python.org fields:

activity = <Date 2020-04-11.01:16:06.060>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2020-04-06.14:43:33.212>
creator = 'bar.harel'
dependencies = []
files = []
hgrepos = []
issue_num = 40205
keywords = []
message_count = 2.0
messages = ['365859', '366173']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'docs@python', 'bar.harel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40205'
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

Die Payload nennt keine Dokumentationsdatei und keinen Test. Finde den Dokumentationseintrag für den Parameter builtins der Funktion profile, füge die fehlende Erklärung hinzu und überprüfe, dass die resultierende Referenzdokumentation ihn eindeutig 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.