Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- SymPy
- Redator técnico:
- lglattly (link em inglês)
- Nome do projeto:
- Consistência entre docstrings
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Neste projeto, meu objetivo é dar mais consistência aos documentosstrings do SymPy.
Trabalhando com meus mentores, primeiro eu identificaria a formatação desejada para um docstring na base de código. Em seguida, criaria um guia de formatação da documentação para todas as docstrings em toda a base de código a serem seguidas. Meu trabalho no projeto também envolveria a implementação do novo guia para atualizar docstrings existentes, enquanto coleta e aborda outras inconsistências, como uso de linguagem ou termos. Meus mentores e eu tomamos decisões editoriais sobre como lidar com essas inconsistências adicionais, e as preferências estilísticas resultantes também seriam adicionadas ao guia.
O objetivo final do projeto seria uma formatação de documentação e guia de estilo que poderia ser usado por desenvolvedores e colaboradores para ajudar a manter a consistência nas docstrings do SymPy agora e no futuro.