falconry/falcon

Consider moving all the tutorial code to files, having not only the final version there

Open

#2247 aperta il 13 lug 2024

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Python (925 fork)batch import
documentationgood first issuemaintenance

Metriche repository

Star
 (9293 star)
Metriche merge PR
 (Merge medio 2g 7h) (9 PR mergiate in 30 g)

Descrizione

At the moment only the final version of the tutorials is in the example folder, while the intermediate code is pasted into the rst files.

It would be nice to have all versions in code, so that lint and format tool etc could work on those too.

We could probably use examples/asgilook/versions/01_file.py, examples/asgilook/versions/02_file.py etc

Guida contributor

Direzione di ricerca
Esamina la cartella 'examples/asgilook/' e i file RST del tutorial. Proponi uno schema di denominazione per i file con versione (es. '01 file.py', '02 file.py') e sposta il codice intermedio dai file RST in questi nuovi file. Aggiorna i file RST per includere il codice dai nuovi file invece di frammenti inline. Assicurati che gli strumenti di lint e formattazione possano essere applicati a tutti i file con versione.
Tech stack
python
Dominio
documentation
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80