From fa5488204f9dbb78ce4ee98c7057f8f3bbbd6099 Mon Sep 17 00:00:00 2001
From: Oscar Roisin <oscar.roisin@etu.utc.fr>
Date: Sun, 23 Jun 2019 17:26:39 +0200
Subject: [PATCH] update doc for map.py

---
 map.py | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/map.py b/map.py
index 0ab171c..6978ac2 100644
--- a/map.py
+++ b/map.py
@@ -13,7 +13,16 @@ numeric_columns.remove('lat')
 FIRST_DAY = loading.FIRST_DAY
 LAST_DAY = loading.LAST_DAY
 
-
+'''
+name: getDailyIndicator
+description: verify date and return data from database
+parameters:
+    * year: year in yyyy format
+    * month: month in mm format
+    * day: day in dd format
+    * indicators: list of indicators
+return: list of dictionnary, a dictionnary for each station
+'''
 def getDailyIndicator(year, month, day, indicators):
     # Verify if date exists in the database
     if verifyDateInPeriod(FIRST_DAY, LAST_DAY, year, month, day):
@@ -39,11 +48,11 @@ def getDailyIndicator(year, month, day, indicators):
         return []
 
 '''
-name : mapIndicator
-description : Enregistre la carte représentant les indicateurs souhaités pour la date précisée en paramètre
-parameters :
-    * date : date au format yyyy-mm-dd
-    * indicators : liste d'indicateurs
+name: mapIndicator
+description: save a map with stations' indicators for the chosen date
+parameters:
+    * date : date in yyyy-mm-dd format
+    * indicators : list of indicators 
 '''
 def mapIndicator(date, indicators):
     # Split date and filter indicators
-- 
GitLab