Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo progetto
- Organizzazione open source:
- SymPy
- Redattore tecnico:
- lglattly
- Nome del progetto:
- Coerenza tra le docstring
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Per questo progetto, vorrei apportare una maggiore coerenza alle docstring di SymPy.
Collaborando con i miei mentori, prima identificherei la formattazione desiderata per una docstring nel codebase. Poi, avrei creato una guida alla formattazione della documentazione da seguire per tutte le docstring del codice base. Il mio lavoro sul progetto comporterebbe anche l'implementazione della nuova guida per aggiornare le stringhe di documenti esistenti, raccogliendo e risolvendo al contempo altre incoerenze come l'uso della lingua o i termini. I miei mentori e io prenderemo insieme le decisioni redazionali su come gestire queste ulteriori incoerenze e le preferenze stilistiche risultanti verranno aggiunte alla guida.
L'obiettivo finale del progetto è una guida allo stile e alla formattazione della documentazione che possa essere utilizzata sia dagli sviluppatori che dai collaboratori per contribuire a mantenere la coerenza nelle docstring di SymPy ora e in futuro.