Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- SymPy
- Rédacteur technique:
- lglattly
- Nom du projet:
- Cohérence entre les docstrings
- Durée du projet:
- Durée standard (3 mois)
Project description
Pour ce projet, je voudrais apporter plus de cohérence aux docstrings de SymPy.
En collaboration avec mes mentors, j'ai d'abord identifié le formatage souhaité pour une docstring dans le codebase. Je créerais ensuite un guide de mise en forme de la documentation que tous les docstrings du codebase devront suivre. Mon travail sur le projet consistera également à implémenter le nouveau guide pour mettre à jour les docstrings existantes, tout en collectant et en corrigeant d'autres incohérences telles que l'utilisation de la langue ou les termes. Mes mentors et moi-même prenions 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ésultaient étaient également ajoutées au guide.
L'objectif final du projet est de créer un guide de style et de mise en forme de la documentation qui pourra être utilisé à la fois par les développeurs et les contributeurs pour maintenir la cohérence dans les docstrings de SymPy, maintenant et à l'avenir.