python / python/cpython

Possibly misleading/wrong documentation about PyModuleDef.m_free

Offen
#78,659 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.7 (EOL) 3.8 (EOL) docs type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

BPO 34478
Nosy @segevfiner

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 2018-08-23.15:07:34.636>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Possibly misleading/wrong documentation about PyModuleDef.m_free'
updated_at = <Date 2018-08-23.15:07:34.636>
user = 'https://github.com/segevfiner'

bugs.python.org fields:

activity = <Date 2018-08-23.15:07:34.636>
actor = 'Segev Finer'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-08-23.15:07:34.636>
creator = 'Segev Finer'
dependencies = []
files = []
hgrepos = []
issue_num = 34478
keywords = []
message_count = 1.0
messages = ['323955']
nosy_count = 2.0
nosy_names = ['docs@python', 'Segev Finer']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34478'
versions = ['Python 3.7', 'Python 3.8']

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 Python-Dokumentation zu finden, die PyModuleDef.m_free beschreibt, und vergleiche ihre Formulierung mit dem Verhalten oder der API-Definition. Ermittle die genau irreführende Aussage, bevor du sie änderst, und überprüfe anschließend, dass die überarbeitete Dokumentation m_free und seine Verwendung korrekt erklärt.

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
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

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