Meta documentation update: valid args

describe valid args of getting/setting/deleting meta indicators
iiasa · Aug 6, 2020 · 9ba12e3 · 9ba12e3
1 parent 6df062f
commit 9ba12e3
Showing 1 changed file with 21 additions and 4 deletions.
diff --git a/ixmp/backend/base.py b/ixmp/backend/base.py
@@ -941,6 +941,13 @@ def get_meta(self, model: str, scenario: str, version: int) -> dict:
         -------
         dict (str -> any)
             Mapping from meta category keys to values.
+
+        Raises
+        ------
+        ValueError
+            On unsupported model-scenario-version combinations.
+            Supported combinations are: (model), (scenario), (model, scenario),
+            (model, scenario, version)
         """
 
     @abstractmethod
@@ -960,6 +967,13 @@ def set_meta(self, meta: dict, model: str, scenario: str, version: int):
         Returns
         -------
         None
+
+        Raises
+        ------
+        ValueError
+            On unsupported model-scenario-version combinations.
+            Supported combinations are: (model), (scenario), (model, scenario),
+            (model, scenario, version)
         """
 
     @abstractmethod
@@ -980,6 +994,13 @@ def remove_meta(self, categories: list, model: str, scenario: str,
         Returns
         -------
         None
+
+        Raises
+        ------
+        ValueError
+            On unsupported model-scenario-version combinations.
+            Supported combinations are: (model), (scenario), (model, scenario),
+            (model, scenario, version)
         """
 
     @abstractmethod
@@ -990,10 +1011,6 @@ def get_scenario_meta(self, s: Scenario):
         -------
         dict (str -> any)
             Mapping from meta keys to values.
-
-        See also
-        --------
-        s_get_meta
         """
 
     @abstractmethod