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:
- Soumi7
- Nome progetto:
- Coerenza nelle docstring - Documentazione di Sympy
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Riassunto :
Documentazione sullo stato attuale della Sympy e lavori precedenti :
La creazione di una guida di stile ufficiale per SymPy è terminata.
Il progetto GSoD di Lauren Glattly ha creato una guida di stile per le docstring di SymPy, disponibile nella guida di stile della documentazione di SymPy.
Le docstring nel sottomodulo Speciale e nel file solvers.py sono state modificate in modo da seguire costantemente le linee guida della nuova guida di stile
Anche tutti gli altri docstring nel codebase dovevano essere modificati per rispettare la nuova guida di stile.
Lavoro proposto :
La maggior parte delle docstring in SymPy non segue ancora la guida di stile più recente. L'obiettivo di questo progetto è aggiornare le docstring in SymPy per ottemperare a questa guida.
Ho parlato del progetto con i mentori. Ecco un link alla discussione.
È stato deciso che modificare le docstring del codebase di sympy per aderire alla guida di stile più recente è un grande compito e il progetto dovrebbe essere limitato a questo.
Il mio lavoro sul progetto prevedeva l'implementazione della nuova guida per aggiornare le docstring esistenti, raccogliendo e risolvendo altre incoerenze come l'uso della lingua o i termini.
L'ordine delle sottosezioni esistenti può essere modificato o deciso in un secondo momento oppure come attività separata.
Dimostrazione delle differenze nei risultati quando diversi valori vengono trasferiti ai parametri mediante l'aggiunta di altri esempi e dell'aggiunta della sezione dei parametri.
Continua ad aggiungere esempi complessi alla sezione degli errori e degli errori.
Contributi: - #17887 : Si è lavorato sul problema n. 17887: Aggiunta di sezioni docstring mancanti nel sottomodulo speciale. Ho aggiunto la sezione Parametri ed esempi mancanti in alcune funzioni del sottomodulo Speciali che è stato modificato da L. Seguire con piacere la guida di stile più recente e fungere da modello per le docstring future.
Ecco il link al mio PR unito : https://github.com/sympy/sympy/pull/19334
- #19591 : Il numero #19591 tiene traccia della guida di stile della documentazione. Ho aggiunto un PR per modificare la docstring core.sympify in modo che aderisca all'ultima guida di stile. Ho aggiunto spiegazioni strutturate ed esempi sull'utilizzo di parametri diversi.
Ecco un link al PR: https://github.com/sympy/sympy/pull/19613
Obiettivi del progetto
Sequenza temporale Prima del 17 agosto :
- Continua a dare contributi all'organizzazione.
- Acquisire familiarità con la documentazione utente e la versione corrente di sympy.
- Apprendi tecniche e competenze che ti saranno utili durante l'implementazione del progetto.
Legami comunitari : (17 agosto - 13 settembre 2020)
- Imposta un canale di comunicazione e un orario (a causa della differenza di tempo).
- Perfeziona i miei obiettivi e definisci le aspettative da entrambi i lati.
- Discussione sull'ordine in cui i moduli verranno aggiornati.
- Finalizza l'ordine di modifica dei moduli per renderli conformi alla guida di stile docstring più recente.
Periodo della documentazione(14 settembre 2020 - 30 novembre 2020) :
Definisci gli obiettivi da raggiungere ogni settimana, preferibilmente completando l'aggiornamento delle docstring di un modulo o di un sottomodulo alla settimana o più.
Per tutti questi moduli, il mio obiettivo principale sarà aggiungere le sezioni mancanti e riorganizzare le docstring in modo da seguire l'ultima guida di stile. Ciò include la dimostrazione dei diversi risultati ottenuti quando vengono trasmessi diversi valori ai parametri. Tutti gli output complicati verranno aggiunti alla sezione Oggetti e insidie.
Settimana 1 ( 14 settembre - 21 settembre) : base
Settimana 2 (22 settembre - 29 settembre) : Funzioni : Sottomoduli Combinatoriali
Settimana 3 (30 settembre - 6 ottobre) : Funzioni
Settimana 4 (7 - 14 ottobre) : Semplifica, Crypto
Settimana 5 (15 ottobre - 21 ottobre) : Diofante
Settimana 6 (22 ottobre - 29 ottobre):Sottomodulo Holonomic :Operations
Settimana 7 (30 ottobre - 7 novembre) : Integrals Module(integrals.integrals), Computing Integrals using Meijer G-Functions
Settimana 8 (8 novembre - 15 novembre) : Fisica, Funzioni alla fine del Modulo relativo alle categorie, Modulo di generazione del codice, Sottomodulo speciale
Settimana 9 (16 novembre - 23 novembre) : Fisica, Funzioni alla fine del Modulo relativo alle categorie, Modulo di generazione del codice, Sottomodulo speciale
Settimana 10 (24 Novembre - 30 Novembre) : sezione Gotcha e insidie
30 novembre - 5 dicembre 2020 alle 18:00 UTC : Invio finale del progetto e scrittura del report
3 - 10 dicembre 2020 alle 18:00 UTC : Invio del successo del progetto e dell'esperienza di lavoro con i mentori
L'ordine dei moduli menzionati qui può essere modificato dopo un'ulteriore discussione con i mentori.
Come suggerito dai mentori, mi concentrerò sull'aggiornamento dei moduli più semplici da aggiornare, per poi passare a quelli più complessi.
Perché sono la persona giusta per questo progetto?
Credo di essere la persona giusta per questo progetto perché ho passato esperienza in scrittura tecnica in informatica e ho molta esperienza con Git e GitHub.
Dato che ho inviato dei PR per aggiornare la documentazione all'ultima guida di stile in Sympy che è stata unita correttamente, sono fiducioso con il flusso di lavoro e con l'invio di contributi regolari.
Quando ho iniziato a contribuire, ho riscontrato alcuni errori. Finalmente mi sono abituato a eseguire i test e a creare i documenti ogni volta prima di applicare le modifiche, dato che è molto importante.
Mi sento molto a mio agio nel contribuire a questo progetto e non vedo l'ora che diventi disponibile.