Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- SymPy
- Technical writer:
- brillantini
- Nome progetto:
- Coerenza nelle docstring
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Per questo progetto, vorrei portare maggiore coerenza alle docstring di SymPy.
Lavorando con i miei mentori, per prima cosa ho identificato la formattazione desiderata per una docstring nel codebase. Quindi creerei una guida alla formattazione della documentazione per tutti i docstring nel codebase da seguire. Il mio lavoro sul progetto comportava anche l'implementazione della nuova guida per aggiornare le docstring esistenti, raccogliendo e risolvendo altre incoerenze come l'uso della lingua o i termini. Io e i miei mentori prenderemo insieme decisioni editoriali su come gestire queste incoerenze aggiuntive e anche le preferenze stilistiche risultanti verrebbero aggiunte alla guida.
L'obiettivo finale del progetto sarebbe una guida di stile e di formattazione della documentazione utilizzabile sia dagli sviluppatori che dai collaboratori per mantenere la coerenza nelle docstring di SymPy ora e in futuro.