python / python/cpython

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

Ouverte
#148,961 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Ouvrez Doc/c-api/typeobj.rst et examinez les deux légendes autour des lignes 172–187. Vérifiez comment la documentation rendue gère la référence croisée PyType_Ready et le littéral inline NULL ailleurs dans le fichier. C’est terminé lorsque les deux légendes rendent le markup au lieu d’astérisques littéraux, avec le formatage prévu pour la référence et le littéral.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.