Esta página contiene 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:
- de forma ilegítima
- Nombre del proyecto:
- Coherencia entre docstrings
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
En este proyecto, buscaría aportar mayor coherencia a las docstrings de SymPy.
Al trabajar con mis mentores, primero identificaba el formato deseado para una docstring en la base de código. Luego, crearía una guía de formato de documentación para seguir todos los docstrings de la base de código. Mi trabajo en el proyecto también implicaría implementar la nueva guía para actualizar las cadenas de documentos existentes, a la vez que recopilar y abordar otras incoherencias como el uso del lenguaje o los términos. Mis mentores y yo tomaríamos juntos las decisiones editoriales sobre cómo manejar estas incoherencias adicionales, y las preferencias estilísticas resultantes también se agregarían a la guía.
El objetivo final del proyecto sería brindar una guía de estilo y formato de documentación que los desarrolladores y colaboradores usaran para mantener la coherencia en las strings de documentos de SymPy ahora y en el futuro.