Merge pull request #2102 from martinholmer/fix-filer-doc

Clarify documentation of filer input variable
PSLmodels · Nov 8, 2018 · ad49057 · ad49057
2 parents 1f327f0 + fc8b9f1
commit ad49057
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 17 deletions.
diff --git a/read-the-docs/source/public_api.rst b/read-the-docs/source/public_api.rst
@@ -70,16 +70,10 @@ taxcalc.Growfactors
 .. autoclass:: taxcalc.Growfactors
    :members:
 
-taxcalc.macro_elasticity
-------------------------
-
-.. automodule:: taxcalc.macro_elasticity
-   :members:
-
-taxcalc.ParametersBase
-----------------------
+taxcalc.Parameters
+------------------
 
-.. autoclass:: taxcalc.ParametersBase
+.. autoclass:: taxcalc.Parameters
    :members:
    :exclude-members: _update, _indexing_rates_for_update
 

diff --git a/taxcalc/records_variables.json b/taxcalc/records_variables.json
@@ -479,12 +479,6 @@
       "form": {"2013-2016": "sample construction info"},
       "availability": "taxdata_cps"
     },
-    "filer": {
-      "type": "int",
-      "desc": "1 if unit files an income tax return; 0 if not (not used in tax-calculation logic); in the puf.csv file a value of 1 indicates record is from IRS/SOI PUF and 0 indicates record is from CPS",
-      "form": {"2013-2016": "sample construction info"},
-      "availability": "taxdata_puf, taxdata_cps"
-    },
     "fips": {
       "type": "int",
       "desc": "FIPS state code (not used in tax-calculation logic)",

diff --git a/taxcalc/tests/test_cpscsv.py b/taxcalc/tests/test_cpscsv.py
@@ -107,7 +107,7 @@ def test_cps_availability(tests_path, cps_path):
         if 'taxdata_cps' in vdict.get('availability', ''):
             recvars.add(vname)
     # check that cpsvars and recvars sets are the same
-    assert (cpsvars - recvars) == set()
+    assert (cpsvars - recvars) == set(['filer'])  # TODO: remove filer
     assert (recvars - cpsvars) == set()
 
 

diff --git a/taxcalc/tests/test_pufcsv.py b/taxcalc/tests/test_pufcsv.py
@@ -331,7 +331,7 @@ def test_puf_availability(tests_path, puf_path):
         if 'taxdata_puf' in vdict.get('availability', ''):
             recvars.add(vname)
     # check that pufvars and recvars sets are the same
-    assert (pufvars - recvars) == set()
+    assert (pufvars - recvars) == set(['filer'])  # TODO: remove filer
     assert (recvars - pufvars) == set()