documented the role of makeEulerErrorFunc. Fixes #892

econ-ark · Jan 18, 2021 · a8396c3 · a8396c3
1 parent 2d7b8ab
commit a8396c3
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 0 deletions.
diff --git a/HARK/ConsumptionSaving/ConsAggShockModel.py b/HARK/ConsumptionSaving/ConsAggShockModel.py
@@ -418,6 +418,12 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
+
         """
         raise NotImplementedError()
 

diff --git a/HARK/ConsumptionSaving/ConsIndShockModel.py b/HARK/ConsumptionSaving/ConsIndShockModel.py
@@ -2096,6 +2096,11 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
         """
         # Get the income distribution (or make a very dense one)
         if approx_inc_dstn:
@@ -2676,6 +2681,11 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
         """
         raise NotImplementedError()
 

diff --git a/HARK/ConsumptionSaving/ConsLaborModel.py b/HARK/ConsumptionSaving/ConsLaborModel.py
@@ -455,6 +455,11 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
         """
         raise NotImplementedError()
 

diff --git a/HARK/ConsumptionSaving/ConsMarkovModel.py b/HARK/ConsumptionSaving/ConsMarkovModel.py
@@ -1244,5 +1244,10 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
         """
         raise NotImplementedError()
diff --git a/HARK/ConsumptionSaving/ConsPrefShockModel.py b/HARK/ConsumptionSaving/ConsPrefShockModel.py
@@ -247,6 +247,11 @@ def makeEulerErrorFunc(self, mMax=100, approx_inc_dstn=True):
         Returns
         -------
         None
+
+        Notes
+        -----
+        This method is not used by any other code in the library. Rather, it is here
+        for expository and benchmarking purposes.
         """
         raise NotImplementedError()
-Original file line number
+Diff line change
@@ Expand Up @@
             Returns
             -------
             None
+            Notes
+            -----
+            This method is not used by any other code in the library. Rather, it is here
+            for expository and benchmarking purposes.
             """
             raise NotImplementedError()
@@ Expand Down @@