Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`
Dieses Issue hat noch niemand übernommen.
- 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_Readyis plain text instead of a cross-reference to :c:func:PyType_Ready.NULLis plain text instead of theNULLinline literal used elsewhere in the same file.
Linked PRs
- gh-148962
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Ö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