python / python/cpython

Pickletools Opcode Documentation Expansion

Offen
#135,041 0 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

Documentation

A few pickle opcode descriptions in the pickletools module are expanded adding a few more details, along with a grammatical fix or two. All expansions to the descriptions come from the code or PEPs, hopefully it's pretty self-explanatory. One paragraph for REDUCE was also removed since it hasn't applied since early Python 2.

Linked PRs
  • gh-135042

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 im Modul pickletools und vergleiche die Beschreibungen der Opcodes mit der relevanten Implementierung und den PEPs. Überprüfe die vorgeschlagenen Erweiterungen, grammatikalischen Korrekturen und die Entfernung des veralteten REDUCE-Absatzes; abgeschlossen ist die Aufgabe, wenn die Beschreibungen das aktuelle Verhalten korrekt wiedergeben und die verknüpfte Änderung vollständig ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/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.