TheAlgorithms / TheAlgorithms/Python
Suggestion: adopt a documentation format for docstring
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 225k
- Forks
- 51.1k
- Merge médio
- 1d 23h
- PRs com merge (30d)
- 156
Descrição
As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:
- Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
There are editor extensions which help in generating the docstring based on the chosen format like:
The doctest will come under the examples section for each of the above format.
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
Comece comparando os formatos Google Docstring, Numpydoc e Sphinx vinculados na issue, incluindo como cada um lida com exemplos de doctest. Revise a discussão para determinar se o projeto escolheu um formato. Considera-se concluído quando houver um formato de documentação acordado e uma maneira definida de aplicá-lo aos docstrings dos algoritmos.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Ativa
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100