python / python/cpython

Doc README omits some documentation make targets

Aberta
#151,833 0 comentários 0 reações 0 responsáveis Ver no GitHub

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

Doc/README.rst lists the available documentation make targets, but it does not mention texinfo, doctest, or gettext.

These targets are defined in Doc/Makefile, so the README target list can be updated to be more complete for contributors reading the documentation build instructions.

Linked PRs
  • gh-151832

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

Compare a lista de targets em Doc/README.rst com os targets definidos em Doc/Makefile, começando por esses arquivos. Atualize o README para mencionar texinfo, doctest e gettext e, em seguida, verifique se a lista documentada corresponde aos targets disponíveis.

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

Receba novas issues na sua caixa de entrada

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