Commit fa548820 authored by Oscar Roisin's avatar Oscar Roisin

update doc for map.py

parent d9dbe1a5
...@@ -13,7 +13,16 @@ numeric_columns.remove('lat') ...@@ -13,7 +13,16 @@ numeric_columns.remove('lat')
FIRST_DAY = loading.FIRST_DAY FIRST_DAY = loading.FIRST_DAY
LAST_DAY = loading.LAST_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): def getDailyIndicator(year, month, day, indicators):
# Verify if date exists in the database # Verify if date exists in the database
if verifyDateInPeriod(FIRST_DAY, LAST_DAY, year, month, day): if verifyDateInPeriod(FIRST_DAY, LAST_DAY, year, month, day):
...@@ -39,11 +48,11 @@ def getDailyIndicator(year, month, day, indicators): ...@@ -39,11 +48,11 @@ def getDailyIndicator(year, month, day, indicators):
return [] return []
''' '''
name : mapIndicator name: mapIndicator
description : Enregistre la carte représentant les indicateurs souhaités pour la date précisée en paramètre description: save a map with stations' indicators for the chosen date
parameters : parameters:
* date : date au format yyyy-mm-dd * date : date in yyyy-mm-dd format
* indicators : liste d'indicateurs * indicators : list of indicators
''' '''
def mapIndicator(date, indicators): def mapIndicator(date, indicators):
# Split date and filter indicators # Split date and filter indicators
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment