python / python/cpython

`PyUnicode_DecodeCharmap`: `mapping` argument not fully documented

Offen
#156,098 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs easy topic-C-API
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

PyUnicode_DecodeCharmap has a mapping argument that either takes a mapping or a str:

https://github.com/python/cpython/blob/e8158d1a02d6e5e974d4dbc0633b6a3ad960d7a3/Objects/unicodeobject.c#L8826-L8833

That it takes a str is not documented: https://docs.python.org/3/c-api/unicode.html#character-map-codecs

Linked PRs
  • gh-156147

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

Beginnen Sie mit der Dokumentation zu den Character-Map-Codecs und vergleichen Sie sie mit der Implementierung von PyUnicode_DecodeCharmap in Objects/unicodeobject.c an den referenzierten Zeilen. Als erledigt gilt die Aufgabe, wenn die Annahme eines str als Mapping-Argument auf der relevanten C API-Seite dokumentiert ist; gh-156147 ist im Issue bereits verlinkt.

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
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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