Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- SymPy
- Redator técnico:
- lglattly
- Nome do projeto:
- Consistência entre docstrings
- Duração do projeto:
- Duração padrão (três meses)
Project description
Para este projeto, eu pretendo trazer maior consistência aos docstrings do SymPy.
Trabalhando com meus mentores, primeiro eu identificava a formatação desejada para um docstring na base de código. Em seguida, eu criaria um guia de formatação de documentação para todos os docstrings da base de código. Meu trabalho no projeto também envolveria a implementação do novo guia para atualizar os docstrings existentes, além de coletar e resolver outras inconsistências, como uso de linguagem ou termos. Meus mentores e eu tomaríamos juntos decisões editoriais sobre como lidar com essas outras inconsistências, e as preferências estilísticas resultantes também seriam adicionadas ao guia.
O objetivo final do projeto é criar um guia de estilo e formatação de documentação que possa ser usado por desenvolvedores e colaboradores para manter a consistência nos docstrings do SymPy agora e no futuro.