python / python/cpython

Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`

Offen
#148,961 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

In Doc/c-api/typeobj.rst, the two legends that explain the "D" (default) and "I" (inheritance) columns of the PyTypeObject quick-reference table (lines 172–187) are wrapped in .. code-block:: none. Because code-block renders its content verbatim:

  • *PyType_Ready* and *NULL* appear with literal asterisks.
  • PyType_Ready is plain text instead of a cross-reference to :c:func:PyType_Ready.
  • NULL is plain text instead of the NULL inline literal used elsewhere in the same file.
Image
Linked PRs
  • gh-148962

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

Öffne Doc/c-api/typeobj.rst und untersuche die beiden Legenden um die Zeilen 172–187. Prüfe, wie die gerenderte Dokumentation den PyType_Ready-Querverweis und das Inline-Literal NULL an anderer Stelle in der Datei behandelt. Fertig ist die Änderung, wenn beide Legenden Markup statt wörtlicher Sternchen rendern und die beabsichtigte Referenz- und Literalformatierung aufweisen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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