Progetto SymPy
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-07-25 UTC."],[],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
