Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- SymPy
- Rédacteur technique:
- aisée
- Nom du projet:
- Cohérence entre les docstrings
- Durée du projet:
- Durée standard (3 mois)
Project description
Pour ce projet, mon but serait d'apporter une plus grande cohérence aux docstrings de SymPy.
En travaillant avec mes mentors, j'aurais d'abord identifié la mise en forme souhaitée pour une docstring dans le codebase. Je créerais ensuite un guide de mise en forme de la documentation pour toutes les docstrings du codebase à suivre. Mon travail sur le projet impliquerait également la mise en œuvre du nouveau guide pour mettre à jour les docstrings existantes, tout en collectant et en corrigeant d'autres incohérences telles que l'utilisation du langage ou les termes. Mes mentors et moi-même prendreions ensemble des décisions éditoriales sur la façon de gérer ces incohérences supplémentaires, et les préférences stylistiques qui en résulteraient seraient également ajoutées au guide.
L'objectif final du projet serait un guide de mise en forme et de style de la documentation qui pourrait être utilisé par les développeurs et les contributeurs afin de maintenir la cohérence dans les docstrings de SymPy aujourd'hui et à l'avenir.