v0.4.27: deprecated Historical State Access

cadCAD-org · Aug 26, 2021 · 12e2b15 · 12e2b15
1 parent 37880a0
commit 12e2b15
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/documentation/Historically_State_Access.md b/documentation/Historically_State_Access.md
@@ -1,4 +1,4 @@
-Historical State Access (Alpha)
+Historical State Access (DEPRECATED)
 ==
 #### Motivation
 The current state (values of state variables) is accessed through the `s` list. When the user requires previous state 

diff --git a/documentation/README.md b/documentation/README.md
@@ -133,7 +133,7 @@ Parameters:
 * **_params** : _dict_ - [System parameters](System_Model_Parameter_Sweep.md)
 * **substep** : _int_ - Current [substep](#Substep)
 * **sH** : _list[list[dict_]] - Historical values of all state variables for the simulation. See 
-[Historical State Access](Historically_State_Access.md) for details
+[Historical State Access (DEPRECATED)](Historically_State_Access.md) for details
 * **s** : _dict_ - Current state of the system, where the `dict_keys` are the names of the state variables and the 
 `dict_values` are their current values.
 * **_input** : _dict_ - Aggregation of the signals of all policy functions in the current 
@@ -176,7 +176,7 @@ Parameters:
 * **_params** : _dict_ - [System parameters](System_Model_Parameter_Sweep.md)
 * **substep** : _int_ - Current [substep](#Substep)
 * **sH** : _list[list[dict_]] - Historical values of all state variables for the simulation. See 
-[Historical State Access](Historically_State_Access.md) for details
+[Historical State Access (DEPRECATED)](Historically_State_Access.md) for details
 * **s** : _dict_ - Current state of the system, where the `dict_keys` are the names of the state variables and the 
 `dict_values` are their current values.
 * **\*\*kwargs** - Policy Update feature extensions