Improve docstrings for public methods calling Parameters._update method.

PSLmodels · Apr 14, 2019 · 75deaa3 · 75deaa3
1 parent 11bd52e
commit 75deaa3
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/taxcalc/consumption.py b/taxcalc/consumption.py
@@ -41,7 +41,8 @@ def update_consumption(self, revision,
                            print_warnings=True, raise_errors=True):
         """
         Update consumption default values using specified revision dictionary.
-        (see Parameters._update for argument documentation.)
+        See Parameters._update for argument documentation and details about
+        the expected structure of the revision dictionary.
         """
         self._update(revision, print_warnings, raise_errors)
 

diff --git a/taxcalc/growdiff.py b/taxcalc/growdiff.py
@@ -39,7 +39,8 @@ def update_growdiff(self, revision,
                         print_warnings=True, raise_errors=True):
         """
         Update growdiff default values using specified revision dictionary.
-        (see Parameters._update for argument documentation.)
+        See Parameters._update for argument documentation and details about
+        the expected structure of the revision dictionary.
         """
         self._update(revision, print_warnings, raise_errors)
 

diff --git a/taxcalc/parameters.py b/taxcalc/parameters.py
@@ -246,6 +246,12 @@ def _update(self, revision_, print_warnings, raise_errors):
         Parameters
         ----------
         revision_: parameter-changes dictionary in param:year:value format
+            Each param primary key must be a string;
+            each year secondary key must be an integer; and
+            each value item must be either
+              a real/integer/boolean/string value for a scalar parameter
+              or
+              a list of real/integer/boolean/string values for a vector param.
 
         print_warnings: boolean
             if True, prints warnings when parameter_warnings exists;
@@ -261,9 +267,10 @@ def _update(self, revision_, print_warnings, raise_errors):
         ------
         ValueError:
             if revision_ is not a dictionary.
-            if each revision_ key is not a valid parameter name
-            if minimum YEAR in revision_ is less than current_year.
-            if maximum YEAR in revision_ is greater than end_year.
+            if each revision_ primary key is not a valid parameter name.
+            if each revision_ secondary key is not an integet.
+            if minimum year in revision_ is less than current_year.
+            if maximum year in revision_ is greater than end_year.
             if _validate_names_types generates errors
             if _validate_values generates errors and raise_errors is True
 

diff --git a/taxcalc/policy.py b/taxcalc/policy.py
@@ -103,7 +103,8 @@ def implement_reform(self, reform,
                          print_warnings=True, raise_errors=True):
         """
         Implement specified policy reform and leave current_year unchanged.
-        (see Parameters._update for argument documentation.)
+        See Parameters._update for argument documentation and details about
+        the expected structure of the reform dictionary.
         """
         self._update(reform, print_warnings, raise_errors)