Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`
Aberta
Ninguém assumiu esta issue ainda.
docs
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Abra Doc/c-api/typeobj.rst e inspecione as duas legendas próximas às linhas 172–187. Verifique como a documentação renderizada trata a referência cruzada PyType_Ready e o literal inline NULL em outra parte do arquivo. Está concluído quando ambas as legendas renderizam markup em vez de asteriscos literais, com a formatação pretendida para a referência e o literal.
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
- 1/5
- Tempo estimado
- Menos de uma hora
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 25/100