Clarify documentation of filer input variable #2102
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The name of the input variable,
filer
, is misleading because some might think a variable with that name is an output variable that indicates whether or not the unit filed an income tax return in the Tax-Calculator simulation. This would appear to be what happened in issue #2099, which was raised by one of our most advanced users.Do people think we should change this variable name in the taxdata and Tax-Calculator repositories? If so, what should the new variable name be? Something like
data_source
? Other ideas?Can people suggest better
records_variables.json
documentation text than what is proposed in this pull request?The focus of this pull request has changed as described here and here.
@MattHJensen @andersonfrailey @hdoupe @evtedeschi3