python / python/cpython

Replace some autogenerated Stable ABI notes with manual ones

Ouverte
#156,870 2 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs topic-C-API
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

We generate Stable ABI notes automatically. This works well in most cases.
But in compact lists/tables of many similar definitions, the notes get repetitive, and take up too much vertical space:

Image

Let's skip the generated notes in this case, and manually add a common note before the table:

Image
Linked PRs
  • gh-156871
  • gh-156875

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

Examinez la génération des notes de Stable ABI décrite dans l’issue et comparez les tableaux compacts présentés dans ses exemples. L’issue ne nomme aucun fichier ni test ; utilisez les PR liés gh-156871 et gh-156875 pour identifier la documentation concernée et confirmer que les notes générées répétitives sont remplacées par une note manuelle partagée.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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