Merge pull request #2297 from martinholmer/2-0-0

Update RELEASES.md info for Tax-Calculator release 2.0.0

CHANGES.md

@@ -2,6 +2,17 @@ TAX-CALCULATOR CHANGE HISTORY
 =============================
 
 
+Changes in release 2.0.0 on 2019-04-??
+--------------------------------------
+
+**This is a major release with changes that make Tax-Calculator
+incompatible with earlier releases.**  Read
+[this document](UPGRADING.md#upgrading-to-tax-calculator-20)
+to understand what you need to do before using Tax-Calcualtor 2.0.
+
+- Simplify and standardize the way that policy reforms (and assumption changes) are specified in both JSON files and Python dictionaies
+
+
 Changes in release 1.2.0 on 2019-03-24
 --------------------------------------
 

RELEASES.md

@@ -4,6 +4,36 @@ Go [here](https://github.com/PSLmodels/Tax-Calculator/pulls?q=is%3Apr+is%3Aclose
 for a complete commit history.
 
 
+2019-04-?? Release 2.0.0
+------------------------
+(last merged pull request is
+[#2296](https://github.com/PSLmodels/Tax-Calculator/pull/2296))
+
+**This is a major release with changes that make Tax-Calculator
+incompatible with earlier releases.**  Read
+[this document](UPGRADING.md#upgrading-to-tax-calculator-20)
+to understand what you need to do before using Tax-Calcualtor 2.0.
+
+**API Changes**
+
+- Simplify and standardize the way that policy reforms (and assumption changes) are specified in both JSON files and Python dictionaies
+  [[#2292](https://github.com/PSLmodels/Tax-Calculator/pull/2292)
+  by Martin Holmer]
+
+**New Features**
+- Revise Tax-Calculator versus TASIM-27 validation test logic
+  [[#2278](https://github.com/PSLmodels/Tax-Calculator/pull/2278)
+  by Martin Holmer]
+- Update Tax-Calculator versus TASIM-27 validation test results
+  [[#2279](https://github.com/PSLmodels/Tax-Calculator/pull/2279)
+  by Martin Holmer]
+
+**Bug Fixes**
+- Fix Windows-related bug in `docs/cookbook/test_recipes.py` that generated FAIL messages when there were only whitespace differences
+  [[#2280](https://github.com/PSLmodels/Tax-Calculator/pull/2280)
+  by Martin Holmer with bug reported by Robert Orr and fix tested on Windows by Duncan Hobbs]
+
+
 2019-03-24 Release 1.2.0
 ------------------------
 (last merged pull request is

UPGRADING.md

@@ -24,7 +24,7 @@ In both cases you need to do the following:
 1. Remove the leading underscore character from each parameter name.
 
 2. Remove the brackets around the value of scalar parameters (i.e.,
-   those that do not vary by filing-unit type, number of EITC eligible
+   those that do not vary by filing-unit type, number of EITC-eligible
    children, or type of itemized deduction, and therefore, are just a
    single value in any year).
 

docs/cookbook.html

@@ -16,7 +16,7 @@ <h1 id="toc">Cookbook of Tested Recipes for Python Programming with
 federal income and payroll tax simulation model, in Python scripts
 that you can run on your own computer.  Note that these recipes
 assume that you have installed the taxcalc package for
-Tax-Calculator release 1.1.0 or higher and the behresp package for
+Tax-Calculator release 2.0.0 or higher and the behresp package for
 Behavioral-Responses release 0.7.0 or higher, and that you are
 running on Python 3.6 or Python 3.7.  For other ways of using
 Tax-Calculator, see the

docs/index.htmx

@@ -964,6 +964,7 @@ section.</p>
 <p><a href="#pol-personal-exemptions">Personal Exemptions</a></p>
 <p><a href="#pol-standard-deduction">Standard Deduction</a></p>
 <p><a href="#pol-nonrefundable-credits">Nonrefundable Credits</a></p>
+<p><a href="#pol-childdependent-credits">Child/Dependent Credits</a></p>
 <p><a href="#pol-itemized-deductions">Itemized Deductions</a></p>
 <p><a href="#pol-capital-gains-dividends">Capital Gains And Dividends</a></p>
 <p><a href="#pol-personal-income">Personal Income</a></p>

docs/make_index.py

@@ -102,7 +102,7 @@ def policy_param_text(pname, param):
     txt += '<br><i>Value Type:</i> {}'.format(param['value_type'])
     txt += '<br><i>Known Values:</i>'
     if len(param.get('vi_vals', [])) > 0:
-        cols = ', '.join(param['vi_name'])
+        cols = ', '.join(param['vi_vals'])
         txt += '<br>&nbsp;&nbsp; for: [{}]'.format(cols)
     for cyr, val in zip(param['value_yrs'], param['value']):
         final_cyr = cyr
@@ -237,6 +237,8 @@ def assumption_param_text(pname, ptype, param):
     minval = param['valid_values']['min']
     maxval = param['valid_values']['max']
     txt += ' min = {} and max = {}'.format(minval, maxval)
+    invalid_action = param.get('invalid_action', 'stop')
+    txt += '<br><i>Out-of-Range Action:</i> {}'.format(invalid_action)
     txt += '</p>'
     return txt
 

read-the-docs/source/conf.py

@@ -62,7 +62,7 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-version = '1.2.0'
+version = '2.0.0'
 release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation

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)
 

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)
 

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
 

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)