Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- SymPy
- Redattore tecnico:
- Soumi7
- Nome del progetto:
- Coerenza tra le docstring - Documentazione di Sympy
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Abstract :
Stato attuale della documentazione di Sympy e lavoro precedente :
Il lavoro di creazione di una guida di stile ufficiale per SymPy è stato completato.
Il progetto GSoD di Lauren Glattly ha creato una guida di stile per le docstring di SymPy, disponibile all'indirizzo SymPy Documentation Style Guide.
Le docstring nel sottomodulo Special e nel file solvers.py sono state modificate per seguire in modo coerente le linee guida della nuova guida di stile
Tutte le altre docstring del codice di base dovevano essere ancora modificate per essere conformi anche alla 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 in modo che rispettino questa guida.
Ho discusso del progetto con i mentor. Ecco il link alla discussione.
È stato deciso che la modifica delle docstring in tutto il codice sorgente di sympy per rispettare l'ultima guida allo stile è un'attività impegnativa e il progetto deve essere limitato a questo.
Il mio lavoro sul progetto prevede l'implementazione della nuova guida per aggiornare le docstring esistenti, nonché la raccolta e la risoluzione di altre incoerenze, come l'uso della lingua o i termini.
L'ordine delle sezioni secondarie esistenti può essere modificato o deciso in un secondo momento o come attività separata.
Dimostrare le differenze nei risultati quando vengono passati valori diversi ai parametri aggiungendo altri esempi e la sezione di aggiunta dei parametri.
Continua ad aggiungere esempi complicati alla sezione sulle insidie e sui problemi.
Contributi: - #17887 : ho lavorato al problema #17887: aggiungi le sezioni mancanti della docstring nel sottomodulo Special. Ho aggiunto la sezione mancante Parametri ed esempi in alcune funzioni del sottomodulo Speciali, che è stata modificata da L. A presto.
Ecco il link al mio PR unito : https://github.com/sympy/sympy/pull/19334
- #19591 : Il numero 19591 tiene traccia della guida di stile per la documentazione. Ho aggiunto una PR per modificare la docstring di core.sympify in modo che rispetti le ultime linee guida di stile. Ho aggiunto spiegazioni strutturate ed esempi sull'utilizzo di diversi parametri.
Ecco un link al PR: https://github.com/sympy/sympy/pull/19613
Obiettivi del progetto
Tempistiche Prima del 17 agosto :
- Continua a dare il tuo contributo all'organizzazione.
- Acquisisci familiarità con la documentazione utente e con la versione corrente di sympy.
- Acquisisci tecniche e competenze utili per l'implementazione del progetto.
Rafforzamento della community : (17 agosto - 13 settembre 2020)
- Imposta un canale di comunicazione e un orario (a causa dello scarto orario).
- Perfezionare i miei obiettivi e stabilire aspettative da entrambe le parti.
- Discutere l'ordine di aggiornamento dei moduli.
- Definisci l'ordine dei moduli di modifica in modo che rispettino le ultime linee guida di stile per le descrizioni comando.
Periodo di documentazione(14 settembre 2020 - 30 novembre 2020) :
Imposta obiettivi da raggiungere ogni settimana, preferibilmente completa l'aggiornamento delle docstring di un modulo o sottomodulo alla settimana o più.
Per tutti questi moduli, il mio obiettivo principale sarà aggiungere le sezioni mancanti e ristrutturare le docstring in modo che rispettino le ultime linee guida di stile. Verranno dimostrati i diversi risultati ottenuti quando vengono passati valori diversi ai parametri. Tutti i risultati ingannevoli devono essere aggiunti alla sezione Problemi e insidie.
Settimana 1 ( 14 - 21 settembre) : Core
Settimana 2 (22 - 29 settembre) : funzioni : sottomoduli combinatori
Settimana 3 (30 settembre - 6 ottobre) : funzioni
Settimana 4 (7-14 ottobre) : semplifica, cripto
Settimana 5 (15 ottobre - 21 ottobre) : Diophantine
Settimana 6 (22-29 ottobre): sottomodulo Operazioni olonomiche
Settimana 7 (30 ottobre - 7 novembre) : Modulo sugli integrali(integrals.integrals), Calcolo degli integrali mediante le funzioni G di Meijer
Settimana 8 (8 novembre - 15 novembre) : Fisica, Funzioni alla fine del Modulo Categorie, Modulo di generazione del codice, Sottomodulo Speciale
Settimana 9 (16 novembre - 23 novembre) : fisica, funzioni alla fine del modulo Categorie, modulo di generazione di codice, modulo speciale
Settimana 10 (24 novembre - 30 novembre) : sezione Approfondimenti e insidie
30 novembre - 5 dicembre 2020 alle ore 18:00 UTC : invio del progetto finale e stesura del report
3-10 dicembre 2020 alle ore 18:00 UTC : invio del progetto completato e dell'esperienza di lavoro con i mentor
L'ordine dei moduli qui menzionati può essere modificato dopo ulteriori discussioni con i mentori.
Come suggerito dai mentori, mi concentrerò sull'aggiornamento di questi moduli, che sono più facili da aggiornare, poi passerò a quelli complessi.
Perché sono la persona giusta per questo progetto?
Ritengo di essere la persona giusta per questo progetto perché ho esperienza nella scrittura tecnica con l'informatica e ho dimestichezza con git e GitHub.
Poiché ho inviato i PR per aggiornare la documentazione all'ultima guida di stile di Sympy, che è stata unita correttamente, ho fiducia nel flusso di lavoro e nella pubblicazione di contributi regolari.
All'inizio, quando ho iniziato a dare il mio contributo, ho riscontrato alcuni errori. Alla fine mi sono abituato a eseguire i test e a creare i documenti ogni volta prima di applicare le modifiche, perché è molto importante.
Non ho problemi a contribuire a questo progetto e non vedo l'ora di farlo.