From: Christophe Guyeux <christophe.guyeux@univ-fcomte.fr>
Date: Mon, 10 Feb 2020 13:25:36 +0000 (+0100)
Subject: Adding documentation
X-Git-Url: https://bilbo.iut-bm.univ-fcomte.fr/and/gitweb/predictops.git/commitdiff_plain/dd79acdf28d8449d7a7e57d2620da55388fd26ea?ds=sidebyside;hp=6a7cf0e5dd962e7da028cb0d82c6682ac87b0540

Adding documentation
---

diff --git a/lib/source/meteofrance.py b/lib/source/meteofrance.py
index 3f1c3eb..cc2eff1 100644
--- a/lib/source/meteofrance.py
+++ b/lib/source/meteofrance.py
@@ -175,6 +175,14 @@ class MeteoFrance:
     @property
     def dated_features(self):
         '''
+        If the attribute dated_features is None, then we create it: a dictionary
+        with datestamps as keys, and {features: values} as values.
+         - considered features are the ones from meteofrance_features.csv, found
+           in config/features/meteofrance directory
+         - only the closest meteo stations are considered
+
+        Returns:
+            dict: the dictionary of features per datestamp
         '''
         if self._dated_features == None:
             csv_file = Path.cwd() / 'config' / 'features' / 'meteofrance' / 'meteofrance_features.csv'