removed variant_name from the example class ModelVariables. This is more a parameter than a variable.

Author: alixdamman

larray/core/checked.py

@@ -252,7 +252,6 @@ class CheckedSession(Session, AbstractCheckedSession, metaclass=ModelMetaclass):
         >>> class ModelVariables(CheckedSession):
         ...     # --- declare variables with defined types ---
         ...     # Their values will be defined at runtime but must match the specified type.
-        ...     variant_name: str
         ...     birth_rate: Array
         ...     births: Array
         ...     # --- declare variables with a default value ---
@@ -271,12 +270,9 @@ class CheckedSession(Session, AbstractCheckedSession, metaclass=ModelMetaclass):
         >>> variant_name = "baseline"
         >>> # Instantiation --> create an instance of the ModelVariables class.
         >>> # Warning: All variables declared without a default value must be set.
-        >>> m = ModelVariables(
-        ...                   variant_name = variant_name,
-        ...                   birth_rate = zeros((AGE, GENDER)),
-        ...                   births = zeros((AGE, GENDER, TIME), dtype=int),
-        ...                   mortality_rate = 0,
-        ...                   )
+        >>> m = ModelVariables(birth_rate = zeros((AGE, GENDER)),
+        ...                    births = zeros((AGE, GENDER, TIME), dtype=int),
+        ...                    mortality_rate = 0)
 
         >>> # ==== model ====
         >>> # In the definition of ModelVariables, the 'birth_rate' variable, has been declared as an Array object.
@@ -354,7 +350,6 @@ class CheckedSession(Session, AbstractCheckedSession, metaclass=ModelMetaclass):
         >>> # ==== output ====
         >>> # save all variables in an HDF5 file
         >>> m.save(f'{variant_name}.h5', display=True)
-        dumping variant_name ... done
         dumping birth_rate ... done
         dumping births ... done
         dumping mortality_rate ... done