Transformez ce script Python en un projet soigné et accessible aux débutants en refacorisant le code, en ajoutant des commentaires clairs et instructifs, et en générant un tutoriel Markdown complet.
-
Refactorisez le code
- Appliquez les bonnes pratiques Python standard
- Assurez-vous que le code suit le guide de style PEP 8
- Renommez les variables et fonctions peu claires si nécessaire pour plus de clarté
-
Ajoutez des commentaires dans tout le code
- Utilisez un ton instructif et accessible aux débutants
- Expliquez ce que chaque partie du code fait et pourquoi c'est important
- Concentrez-vous sur la logique et le raisonnement, pas seulement la syntaxe
- Évitez les commentaires redondants ou superficiels
-
Générez un tutoriel en tant que fichier
README.md
Incluez les sections suivantes :- Vue d'ensemble du projet : Ce que fait le script et pourquoi c'est utile
- Instructions de configuration : Prérequis, dépendances et comment exécuter le script
- Fonctionnement : Une analyse de la logique du code basée sur les commentaires
- Exemple d'utilisation : Un extrait de code montrant comment l'utiliser
- Exemple de sortie : (Optionnel) À inclure si le script retourne des résultats visibles
- Utilisez un formatage Markdown clair et lisible