Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Typing spec: Improve cross-linking

Aberta
#1,531 1 comentário 1 reação 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Comece revisando a typing spec vinculada, especialmente a página do sistema de tipos e o pull request referenciado. Identifique um pequeno grupo de referências a PEP ou features a serem atualizadas e, em seguida, verifique se as seções relevantes da spec estão vinculadas e se todos os destinos de link adicionados são resolvidos corretamente na documentação gerada.

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

Descrição

topic: documentation topic: typing spec

We should improve links within the spec. Concretely:

  • Replace links to PEPs with links to the relevant part of the spec (https://github.com/python/typing/pull/1517#pullrequestreview-1763857938)
  • Where we mention a feature, link it to the relevant spec section (e.g., whenever we mention Annotated, it should link to the spec section that describes Annotated).
  • Strategically add link targets so other Sphinx docs (e.g., docs.python.org, the PEPs) can link to the spec

This can be done in small increments, one PR at a time, and doesn't need signoff from the Typing Council. Contributions are welcome.

Linguagem predominante
Python
Estrelas
1.8k
Forks
302
Merge médio
4h 16min
PRs com merge (30d)
7

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

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.

Mais de python/typing

Todas as issues de python/typing

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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