Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- SymPy
- Technical writer:
- abbagliante
- Nome progetto:
- Coerenza tra le docstring
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Per questo progetto, voglio portare una maggiore coerenza alle docstring di SymPy.
Lavorando con i miei mentori, dovevo prima identificare la formattazione desiderata per una docstring nel codebase. Poi creerei una guida alla formattazione della documentazione per tutte le docstring nel codebase da seguire. Il mio lavoro sul progetto prevedeva 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 decisioni editoriali su come gestire queste ulteriori incoerenze e anche le preferenze stilistiche che ne derivano sarebbero state aggiunte alla guida.
L'obiettivo finale del progetto è una guida di stile e formattazione della documentazione che possa essere utilizzata sia dagli sviluppatori che dai collaboratori per mantenere la coerenza delle docstring di SymPy ora e in futuro.