python / python/cpython

Fix all Sphinx reference warnings in `Doc/library/email.{charset,parser}.rst`

Offen
#151,947 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs topic-email type-bug
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug report

[!IMPORTANT]
See the meta issue for more information.

Doc/library/email.charset.rst
Doc/library/email.charset.rst:184: py:meth reference target not found: Charset.convert [ref.meth]
Doc/library/email.parser.rst
Doc/library/email.parser.rst:51: py:mod reference target not found: email.feedparser [ref.mod]
Linked PRs
  • gh-151966
  • gh-152178

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 mit Doc/library/email.charset.rst:184 und Doc/library/email.parser.rst:51 und führe anschließend die Prüfung auf Referenzwarnungen für diese Dateien in der Dokumentation aus. Bestätige, dass die Referenzen auf Charset.convert und email.feedparser ohne Warnungen aufgelöst werden; die verknüpften PRs gh-151966 und gh-152178 zeigen, dass die Arbeit bereits im Gange ist.

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
20/100

Neue Issues direkt in Ihr Postfach

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