Adding documentation

[predictops.git] / lib / source / meteofrance.py

diff --git a/lib/source/meteofrance.py b/lib/source/meteofrance.py
index 3f1c3eb1069f9862841362991cf68192b85df8d6..cc2eff1b96024fb6421cee1e011b491a583e2b74 100644 (file)
--- a/lib/source/meteofrance.py
+++ b/lib/source/meteofrance.py
@@ -175,6 +175,14 @@ class MeteoFrance:
     @property
     def dated_features(self):
         '''
     @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'
         '''
         if self._dated_features == None:
             csv_file = Path.cwd() / 'config' / 'features' / 'meteofrance' / 'meteofrance_features.csv'