Projeto SymPy
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-08 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-11-08 UTC."],[[["This project focuses on improving the consistency of docstrings within the SymPy codebase."],["A documentation formatting and style guide will be created and implemented to standardize docstrings."],["The guide will address inconsistencies in formatting, language, and terminology for developers and contributors."],["The project is part of Google Season of Docs and will be completed over three months."]]],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
