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:
- Soumi7
- Nombre del proyecto:
- Coherencia entre docstrings: documentación de Sympy
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Se puede abstraer :
Documentación sobre el estado actual de Sympy y trabajos anteriores :
Se completó el trabajo de crear una guía de estilo oficial para SymPy.
El proyecto de GSoD de Lauren Glattly creó una guía de estilo para las strings de documentos SymPy, que puedes encontrar en la Guía de estilo de la documentación de SymPy.
Se editaron los documentos docstrings del submódulo especial y el archivo solvers.py para que sigan de forma coherente los lineamientos de la nueva guía de estilo.
Todas las demás docstrings de la base de código se debían editar también para cumplir con la nueva guía de estilo.
Trabajo propuesto :
La mayoría de los docstrings en SymPy aún no siguen la guía de estilo más reciente. El objetivo de este proyecto sería actualizar las docstrings en todo SymPy para cumplir con esta guía.
Debatí el proyecto con los mentores. Este es un vínculo al debate.
Se decidió que editar docstrings en la base de código de sympy para cumplir con la guía de estilo más reciente es una tarea enorme y el proyecto debería limitarse a ella.
Mi trabajo en el proyecto implicaría implementar la nueva guía para actualizar las cadenas de documentos existentes y, al mismo tiempo, recopilar y abordar otras incoherencias como el uso del lenguaje o los términos.
Puedes cambiar o decidir el orden de las subsecciones existentes más adelante o como una tarea independiente.
Se muestran las diferencias en los resultados cuando se pasan valores diferentes a los parámetros agregando más ejemplos junto con la sección de parámetros.
Sigue agregando ejemplos complejos en la sección de trampas y trampas.
Contribuciones: - #17887 : Se trabajó en el problema #17887: Se agregaron las secciones docstring que faltaban en el submódulo especial. Agregué la sección de parámetros y ejemplos que falta en algunas funciones del submódulo de Specials, que fue editado por L. Seguir la guía de estilo más reciente y servir como modelo para futuras strings de documentos
Este es el vínculo a mi solicitud de eliminación combinada : https://github.com/sympy/sympy/pull/19334
- #19591 : El error #19591 hace un seguimiento de la guía de estilo de la documentación. Agregué una solicitud de extracción para editar la docstring core.sympify para que cumpla con la guía de estilo más reciente. Agregué explicaciones estructuradas y ejemplos sobre el uso de diferentes parámetros.
Este es un vínculo al PR: https://github.com/sympy/sympy/pull/19613
Objetivos del proyecto
Cronograma Antes del 17 de agosto :
- Seguir contribuyendo a la organización
- Familiarízate con la documentación del usuario y la versión actual de sympy.
- Aprende técnicas y destrezas que 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 y un horario de comunicación (debido a la diferencia horaria).
- Definir mejor mis objetivos y establecer expectativas para ambos lados.
- Analizar el orden en que se actualizarán los módulos.
- Finaliza el orden de los módulos de edición para que cumplan con la guía de estilo de docstring más reciente.
Período de documentación(del 14 de septiembre de 2020 al 30 de noviembre de 2020) :
Establece objetivos para alcanzar cada semana, preferentemente completar la actualización de docstrings de un módulo o submódulo por semana o más.
En todos estos módulos, mi objetivo principal será agregar las secciones que faltan y reestructurar las docstrings para que sigan la última guía de estilo. Esto incluirá mostrar los diferentes resultados que se obtienen cuando se pasan valores distintos a los parámetros. Todos los resultados engañosos se deben agregar a la sección de trampas y errores.
Semana 1 ( del 14 de septiembre al 21 de septiembre) : Principal
Semana 2 (del 22 de septiembre al 29 de septiembre) : Funciones : Combinación de submódulos
Semana 3 (del 30 de septiembre al 6 de octubre) : Funciones
Semana 4 (del 7 de octubre al 14 de octubre) : Simplificación, criptografía
Semana 5 (del 15 de octubre al 21 de octubre) : Diophantina
Semana 6 (del 22 de octubre al 29 de octubre):Submódulo holonómico :Operations
Semana 7 (del 30 de octubre al 7 de noviembre) : Módulo de integrales(integrals.integrals), Procesamiento 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 Categories, módulo de generación de código, submódulo especial
Semana 9 (del 16 de noviembre al 23 de noviembre) : Física, Funciones al final del módulo Categories, módulo de generación de código, submódulo especial
Semana 10 (del 24 de noviembre al 30 de noviembre) : Sección Gotchas y Pitfalls
Del 30 de noviembre al 5 de diciembre de 2020 a las 6:00 p.m. UTC : presentación del proyecto final y redacción del informe
Del 3 al 10 de diciembre de 2020 a las 6:00 p.m. UTC : Presentación del éxito del proyecto y experiencia de trabajo con mentores
El orden de los módulos mencionados aquí se puede cambiar después de una mayor conversación con los mentores.
Según las sugerencias de los mentores, me centraré en actualizar primero esos módulos que son más fáciles de actualizar y, luego, pasaré a los más complejos.
¿Por qué soy la persona indicada para este proyecto?
Creo que soy la persona adecuada para este proyecto porque tengo experiencia previa en escritura técnica en informática y estoy bien capacitado en Git y GitHub.
Ya que envié PR para actualizar la documentación a la guía de estilo más reciente de sympy que se fusionó con éxito, confío en el flujo de trabajo y hago contribuciones periódicas.
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.
Me siento muy cómodo al contribuir en este proyecto y espero con ansias hacerlo.