Dernier commit

README.md

@@ -2,23 +2,23 @@
 
 ---
 
-###### Projet proposé par Pierre CAMELERI Raphaël Guignolle
+###### Projet proposé par Pierre CAMELERI & Raphaël GUIGNOLLE
 
-## Dependencies
+## Dépendances
 
-Ce programme utilise uniquement python 3
 Ce programme est indépendant de l'OS (windows, mac, linux)
+
 Modules natifs utilisés:
 * `math` pour le calcul du logarithme décimal
 * `os` pour lister les fichiers et effacer la console
 
-Ce programme fourni un corpus de document dans `/speeches`. On peut les remplacer ou en ajouter d'autres, ils doivents juste avoir la syntaxe suivante : `/speeches/Nomination_*.txt` avec la partie à compléter un nom de président que l'on peut retrouver dans les cleés du dictionnaire `NOM_PRENOM` dans le module `/consts.py`.
+Ce programme fournit un corpus de document dans `/speeches`. On peut les remplacer ou en ajouter d'autres, ils doivent juste avoir la syntaxe suivante : `/speeches/Nomination_*.txt` <br> * nom de président que l'on peut trouver dans les cleés du dictionnaire `NOM_PRENOM` du module `/consts.py`.
 
 
 > [!WARNING]
-> La version de Python doit être au-dessus ou égale 3.11.0
+> La version de Python doit être au-dessus ou égale à 3.11.0
 
-## Getting started
+## Guide de démarrage
 
 * Cloner le repo via `git clone https://github.com/Emprario/pychatbot-cameleri-guignolle-a`
 * Se déplacer dans le **dossier courant du projet** `cd pychatbot-cameleri-guignolle-a`
@@ -27,11 +27,11 @@ Ce programme fourni un corpus de document dans `/speeches`. On peut les remplace
 Le programme se décompose en deux parties : Chatbot et menu rapide, pour répondre aux menus, vous devez entrer le numéro du choix sélectionné.
 
 > [!TIP]
-> Vous pouvez executer plusieurs fois le programme après appuye de `Entrée` pour effacer la console
-> Vous pouvez également retourner au menu principal en utilisant le choix 0 dans le sous menu des accès rapides
+> Vous pouvez executer plusieurs fois le programme après appuie sur `Entrée` pour effacer la console
+> <br>Vous pouvez également retourner au menu principal en utilisant le choix 0
 
-## Known bugs
+## Bugs connus
 
 Il n'existe pas de bug majeur connu.
-Toutes les saisies sont sécurisées sauf celui de la saisie du nombre à virgule flotante dans le choix du seuil pour le score TF-IDF.
+Toutes les saisies sont sécurisées sauf celle de la saisie du nombre à virgule flottante dans le choix du seuil pour le score TF-IDF.
 Si vous en trouvez, n'hésitez pas à les reporter via [issues](https://github.com/Emprario/pychatbot-cameleri-guignolle-a/issues)

functions.py

@@ -42,6 +42,7 @@ def format_text(text: str) -> str:
     """
     Formate le fichier fourni
     :param text: contenu textuel à traiter
+    :return: texte formatté
     """
 
     buffer = ""  # Stockage du texte post-traitement
@@ -127,9 +128,10 @@ def splitter(separator: str, prompt: str) -> list[str]:
 
 def choose_among(header: str, lst: list[str]) -> int:
     """
-    Renvoie le numéro de l'option choisi par l'utilisateur parmi la liste des options affichées
+    Renvoie le numéro de l'option choisie par l'utilisateur parmi la liste des options affichées
     :param header: tête d'affichage
     :param lst: liste des options
+    :return: numéro de l'option choisie
     """
     print(header)
 

menu.py

@@ -1,7 +1,7 @@
 """
 Projet : pyChatBot
 Auteurs : Pierre Cameleri, Raphaël Guignolle
-Description : Gestion de menus
+Description : Gestion des menus
 """
 
 from functions import *
@@ -15,6 +15,7 @@ def less_important_words(verbose: bool, seuil: int = -1) -> list[str]:
     Renvoie les mots avec un score tf-idf inférieur ou égale à un seuil (zéro compris)
     :param verbose: permet l'affichage ou non du résultat
     :param seuil: indique le seuil minimum (optionnel)
+    :return: liste des mots avec un score tf-idf respectant le seuil
     """
     while seuil < 0:
         seuil = float(input("Indiquez le score maximum souhaité (0 pour les mots \"non-importants\") : "))