falconry/falcon

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

Open

#2 247 ouverte le 13 juil. 2024

Voir sur GitHub
 (8 commentaires) (0 réactions) (0 assignés)Python (925 forks)batch import
documentationgood first issuemaintenance

Métriques du dépôt

Stars
 (9 293 stars)
Métriques de merge PR
 (Merge moyen 2j 7h) (9 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez le dossier actuel 'examples/asgilook/' et les fichiers de tutoriel RST. Proposez un schéma de nommage pour les fichiers versionnés (par exemple '01 file.py', '02 file.py') et déplacez le code intermédiaire des fichiers RST vers ces nouveaux fichiers. Mettez à jour les fichiers RST pour inclure le code des nouveaux fichiers au lieu d'extraits en ligne. Assurez vous que les outils de lint et de formatage puissent être appliqués à tous les fichiers versionnés.
Stack technique
python
Domaine
documentation
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80