Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- SymPy
- Redactor técnico:
- Soumi7
- Nombre del proyecto:
- Coherencia entre docstrings: documentación de Sympy
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Resumen :
Estado actual de la documentación de Sympy y trabajo anterior :
Se completó el trabajo de crear una guía de estilo oficial para SymPy.
El proyecto GSoD de Lauren Glattly creó una guía de estilo para las docstrings de SymPy, que se puede encontrar en la Guía de estilo de documentación de SymPy.
Se editaron las docstrings en el submódulo especial y el archivo solvers.py para seguir de forma coherente los lineamientos del nuevo manual de estilo.
Todas las demás docstrings de la base de código aún debían editarse para cumplir también con la nueva guía de estilo.
Trabajo propuesto :
La mayoría de las docstrings de SymPy aún no siguen el último manual de estilo. El objetivo de este proyecto sería actualizar las docstrings en SymPy para cumplir con esta guía.
Analicé el proyecto con los mentores. Este es un vínculo a la conversación.
Se decidió que editar las docstrings en toda la base de código de sympy para cumplir con la guía de estilo más reciente es una tarea importante y que el proyecto debe limitarse a ella.
Mi trabajo en el proyecto implicaría implementar la nueva guía para actualizar los docstrings existentes y, al mismo tiempo, recopilar y abordar otras inconsistencias, como el uso del lenguaje o los términos.
El orden de las sub secciones existentes se puede cambiar o decidir más adelante o como una tarea independiente.
Se agregaron más ejemplos para demostrar las diferencias en los resultados cuando se pasan diferentes valores a los parámetros, además de la sección de adición de parámetros.
Sigue agregando ejemplos complicados a la sección de errores y dificultades.
Contribuciones: - #17887 : Se trabajó en el problema #17887: Se agregaron secciones de docstring faltantes en el submódulo especial. Agregué la sección Parámetros y ejemplos faltante en algunas funciones del submódulo de ofertas especiales que editó L. Glattly para seguir la guía de estilo más reciente y servir como modelo para docstrings futuros.
Este es el vínculo a mi solicitud de extracción combinada : https://github.com/sympy/sympy/pull/19334
- #19591 : El problema #19591 hace un seguimiento de la guía de estilo de la documentación. Agregué una solicitud de cambios para editar la docstring de core.sympify y cumplir con la guía de estilo más reciente. Se agregaron explicaciones y ejemplos estructurados sobre el uso de diferentes parámetros.
Este es un vínculo a la solicitud de extracción: https://github.com/sympy/sympy/pull/19613
Objetivos del proyecto
Cronograma Antes del 17 de agosto :
- Seguir realizando contribuciones a la organización
- Familiarízate con la documentación del usuario y la versión actual de sympy.
- Aprender técnicas y habilidades que te serán útiles durante la implementación del proyecto
Vinculación con la comunidad: del 17 de agosto al 13 de septiembre de 2020
- Establece un canal de comunicación y una hora (debido a la diferencia horaria).
- Definir mejor mis objetivos y establecer expectativas para ambas partes
- Analizar el orden en el que se actualizarán los módulos
- Finaliza el orden de los módulos de edición para que se ajusten a la guía de estilo de docstring más reciente.
Período de documentación(14 de septiembre de 2020 - 30 de noviembre de 2020) :
Establece objetivos para alcanzar cada semana, preferiblemente completa la actualización de las docstrings de un módulo o submódulo por semana o más.
Para todos estos módulos, mi objetivo principal será agregar las secciones faltantes y reestructurar las docstrings para seguir la guía de estilo más reciente. Esto incluirá demostrar los diferentes resultados que se obtienen cuando se pasan diferentes valores a los parámetros. Todos los resultados engañosos se deben agregar a la sección Problemas y errores.
Semana 1 ( del 14 al 21 de septiembre) : Core
Semana 2 (del 22 al 29 de septiembre) : Funciones : Submódulos combinatorios
Semana 3 (del 30 de septiembre al 6 de octubre) : Funciones
Semana 4 (del 7 al 14 de octubre) : Simplifica, Cripto
Semana 5 (del 15 al 21 de octubre) : Diophantine
Semana 6 (del 22 al 29 de octubre): Submódulo de operaciones de holonómico
Semana 7 (del 30 de octubre al 7 de noviembre) : Módulo de integrales(integrals.integrals), Cálculo de integrales con funciones G de Meijer
Semana 8 (del 8 de noviembre al 15 de noviembre) : Física, funciones al final del módulo de categorías, módulo de generación de código y submódulo especial
Semana 9 (del 16 de noviembre al 23 de noviembre) : Física, funciones al final del módulo de categorías, módulo de generación de código, submódulo especial
Semana 10 (del 24 de noviembre al 30 de noviembre) : Sección Problemas y errores
Del 30 de noviembre al 5 de diciembre de 2020 a las 6:00 p.m. (UTC): Envío del proyecto final y redacción del informe
Del 3 al 10 de diciembre de 2020 a las 6:00 p.m. (UTC): Envío del éxito del proyecto y la experiencia de trabajar con mentores
El orden de los módulos que se mencionan aquí se puede cambiar después de una mayor conversación con los mentores.
Como sugirieron los mentores, me enfocaré primero en actualizar los módulos más fáciles y, luego, pasaré a los más complejos.
¿Por qué soy la persona adecuada para este proyecto?
Creo que soy la persona indicada para este proyecto porque tengo experiencia previa en escritura técnica en informática y tengo mucha experiencia en git y github.
Como envié PR para actualizar la documentación a la guía de estilo más reciente en sympy, que se fusionaron correctamente, confío en el flujo de trabajo y realizo contribuciones con regularidad.
Al principio, cuando comencé a contribuir, me encontré con algunos errores. Finalmente, me acostumbré a ejecutar las pruebas y compilar los documentos cada vez antes de confirmar los cambios, ya que eso es muy importante.
Estoy muy a gusto colaborando en este proyecto y lo espero con ansias.