From 7705235be7abf0904df22ff568a6ad3b8a43fcdb Mon Sep 17 00:00:00 2001
From: "bollet.c" <>
Date: Sat, 18 Feb 2023 10:31:58 +0100
Subject: [PATCH] ajout documentation des fonctions

---
 basket.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/basket.py b/basket.py
index 3071b27..9684929 100644
--- a/basket.py
+++ b/basket.py
@@ -1,4 +1,10 @@
 def reussite(joueur, action):
+    """Prend deux chaînes de caractères :
+            - joueur (le nom du joueur),
+            - action (le type d’action : tir ou lancer).
+       Renvoie deux entiers :
+            - le nombre de tentatives
+            - le nombre de réussit sur l’action en question """
     with open('stats.txt', 'r') as stats:
         stats = stats.readlines()
         nb_action = 0
@@ -12,12 +18,18 @@ def reussite(joueur, action):
         return nb_action, nb_reussite_action
 
 def points(x, y):
+    """Prend deux entiers x et y (les coordonnées du point où a eu lieu l’action).
+       Renvoie un entier:
+            - 2 si le point est à l’intérieur d’un des demi-cercles
+            - 3 sinon"""
     if x**2+(y-300)**2 <= 62500 or (x-1000)**2+(y-300)**2 <= 62500:
         return 2
     else:
         return 3
             
 def totalPoints(joueur):
+    """Prend une chaîne de caractère joueur (le nom du joueur)
+       Renvoie le nombre total de points marqués par ce joueur."""
     with open('stats.txt', 'r') as stats:
         nb_total_points = 0
         for ligne in stats: