Proyecto SymPy
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- SymPy
- Escritor técnico:
- lglattly
- Nombre del proyecto:
- Coherencia entre las docstrings
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Para este proyecto, buscaría brindar mayor coherencia a las docstrings de SymPy.
Cuando trabajaba con mis mentores, primero identificaba el formato deseado para un docstring en la base de código. Luego, crearía una guía de formato de documentación para que todas las docstrings de la base de código la sigan. Mi trabajo en el proyecto también implicaría implementar la nueva guía para actualizar los docstrings existentes, a la vez que recopilar y abordar otras inconsistencias, como el uso del lenguaje o los términos. Mis mentores y yo tomábamos decisiones editoriales en conjunto sobre cómo manejar estas inconsistencias adicionales, y las preferencias estilísticas resultantes también se agregaban a la guía.
El objetivo final del proyecto sería una guía de estilo y formato de documentación que tanto los desarrolladores como los colaboradores podrían usar para ayudar a mantener la coherencia en los docstrings de SymPy ahora y en el futuro.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-08 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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"]]
