python / python/cpython

Replace some autogenerated Stable ABI notes with manual ones

Aperta
#156,870 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs topic-C-API
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina la generazione delle note Stable ABI descritta nell’issue e confronta le tabelle compatte mostrate nei suoi esempi. L’issue non indica file o test; usa le PR collegate gh-156871 e gh-156875 per identificare la documentazione interessata e confermare che le note generate ripetitive vengano sostituite da una nota manuale condivisa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.