python / python/cpython

Replace some autogenerated Stable ABI notes with manual ones

Aberta
#156,870 2 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs topic-C-API
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Revise a geração de notas de Stable ABI descrita na issue e compare as tabelas compactas mostradas em seus exemplos. A issue não nomeia arquivos nem testes; use os PRs vinculados gh-156871 e gh-156875 para identificar a documentação afetada e confirmar que as notas geradas repetitivas são substituídas por uma nota manual compartilhada.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.