ajout docstrings

2024-10-11 08:34:32 +02:00
parent 8ee49a39ac
commit f4a97f08e6
1 changed files with 18 additions and 0 deletions
--- a/POO/TP/TP_POO.md
+++ b/POO/TP/TP_POO.md
@@ -37,9 +37,27 @@ La classe bibliothèque possède deux attributs principaux :
 La classe bibliothèque possède différentes méthodes :

 - Une méthode permettant de savoir si un livre est disponible.
+
+> 	Méthode parcourant l'ensemble des livres de la biblio pour savoir si un livre est disponible
+>         param nom_livre : (str) Nom du livre à rechercher
+>         return : (int) Indice du livre si dispo, -1 sinon"""
+
 - Une méthode permettant de prêter un livre
+
+
+
+> 	Méthode permettant de preter un livre s'il est dispo.
+>         param nom_livre : (str) nom du livre à emprunter
+>         return : (Livre/bool) Livre si emprunt possible, False sinon
+
 - Une méthode permettant d'ajouter un livre dans son rayon. 

+> 	 Méthode permettant d'ajouter un livre.
+>         param livre (Livre): Livre à ajouter
+>         return : (str) précise si le livre est ajouté ou non
+
+
+
 ## 5. Création des objets

 Créer la classe est bien, maintenant il faut manipuler les objets.