Documentation changes for release 0.23.0

PSLmodels · Nov 13, 2018 · d18f393 · d18f393
1 parent 4d89d86
commit d18f393
Show file tree

Hide file tree

Showing 15 changed files with 121 additions and 15 deletions.
diff --git a/docs/cookbook.html b/docs/cookbook.html
@@ -15,7 +15,7 @@ <h1 id="toc">Cookbook of Tested Recipes for Python Programming with
 <p>This document tells you how to use Tax-Calculator, an open-source
 federal income and payroll tax simulation model, in Python scripts
 that you can run on your own computer.  Note that these recipes
-require Tax-Calculator release 0.22.0 or higher running on Python 3.6.
+require Tax-Calculator release 0.23.0 or higher running on Python 3.6.
 For other ways of using Tax-Calculator, see the
 <a href="https://open-source-economics.github.io/Tax-Calculator/">
 user documentation</a>, which this Cookbook assumes you have read.</p>

diff --git a/docs/cookbook/recipe00.res b/docs/cookbook/recipe00.res
@@ -1,6 +1,16 @@
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 
 REFORM DOCUMENTATION

diff --git a/docs/cookbook/recipe01.res b/docs/cookbook/recipe01.res
@@ -1,6 +1,16 @@
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 2018_REFORM1_iitax_rev($B)= 1422.082
 2018_REFORM2_iitax_rev($B)= 1267.362

diff --git a/docs/cookbook/recipe02.res b/docs/cookbook/recipe02.res
@@ -1,8 +1,23 @@
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 2020_CURRENT_LAW_P__itax_rev($B)= 1413.43
 2020_REFORM_STATIC__itax_rev($B)= 1410.78

diff --git a/docs/cookbook/recipe03.res b/docs/cookbook/recipe03.res
@@ -1,4 +1,9 @@
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 Filing Units Receiving EITC and Average Positive EITC by AGI Category
 AGI Category           	 Num(#M)	 Avg($K)

diff --git a/docs/cookbook/recipe04.res b/docs/cookbook/recipe04.res
@@ -1,6 +1,16 @@
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 
 Response in Charitable Giving by Earnings Group

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.htmx b/docs/index.htmx
@@ -40,6 +40,11 @@ ensure you are viewing the most recent version of this page rather
 than an older version that your browser has saved in its cache of
 previously visited pages.</i></p>
 
+<p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-11-13-release-0230">Behavior class is going away soon</a>
+and being replaced by the Behavioral-Responses <kbd>behresp</kbd> package,
+the use of which is demonstrated in
+<a href="https://open-source-economics.github.io/Tax-Calculator/cookbook.html">Cookbook</a> recipe 2</p>
+
 <p><a href="https://github.com/open-source-economics/Tax-Calculator/blob/master/RELEASES.md#2018-10-24-release-0220">Automatic scaling of table results</a>
 (so that Python scripts, and Cookbook recipes, do not need to change
 dollars into billions of dollars and filing units into millions of

diff --git a/docs/recipe00.graph.html b/docs/recipe00.graph.html
diff --git a/docs/recipe00.res.html b/docs/recipe00.res.html
@@ -1,7 +1,17 @@
 <title>recipe00.res</title><pre>
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 
 REFORM DOCUMENTATION

diff --git a/docs/recipe01.res.html b/docs/recipe01.res.html
@@ -1,7 +1,17 @@
 <title>recipe01.res</title><pre>
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 2018_REFORM1_iitax_rev($B)= 1422.082
 2018_REFORM2_iitax_rev($B)= 1267.362

diff --git a/docs/recipe02.res.html b/docs/recipe02.res.html
@@ -1,9 +1,24 @@
 <title>recipe02.res</title><pre>
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 2020_CURRENT_LAW_P__itax_rev($B)= 1413.43
 2020_REFORM_STATIC__itax_rev($B)= 1410.78

diff --git a/docs/recipe03.res.html b/docs/recipe03.res.html
@@ -1,5 +1,10 @@
 <title>recipe03.res</title><pre>
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 Filing Units Receiving EITC and Average Positive EITC by AGI Category
 AGI Category           	 Num(#M)	 Avg($K)

diff --git a/docs/recipe04.res.html b/docs/recipe04.res.html
@@ -1,7 +1,17 @@
 <title>recipe04.res</title><pre>
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
+WARNING: the Behavior class is deprecated and will be removed soon.
+FUTURE: use the Behavioral-Responses behresp package OR
+        use the Tax-Calculator quantity_response function.
 You loaded data for 2014.
+Your data include the following unused variables that will be ignored:
+  filer
 Tax-Calculator startup automatically extrapolated your data to 2014.
 
 Response in Charitable Giving by Earnings Group

diff --git a/read-the-docs/source/conf.py b/read-the-docs/source/conf.py
@@ -62,11 +62,7 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-import taxcalc
-ver = taxcalc.__version__
-version = ver[:ver.rfind('.') + 2]
-# The full version, including alpha/beta/rc tags.
+version = '0.23.0'
 release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation