diff --git a/changelog.d/1671.md b/changelog.d/1671.md new file mode 100644 index 000000000..048a9d68c --- /dev/null +++ b/changelog.d/1671.md @@ -0,0 +1 @@ +- Document `council_tax_less_benefit` as a public-facing convenience variable used by downstream consumers (`policyengine-app`, `council-tax-ctr-map`, `policyengine-uk-data` calibration targets) rather than the core model itself, so future audits do not flag it as dead code. diff --git a/policyengine_uk/variables/household/consumption/council_tax_less_benefit.py b/policyengine_uk/variables/household/consumption/council_tax_less_benefit.py index b1a407394..a59b1c969 100644 --- a/policyengine_uk/variables/household/consumption/council_tax_less_benefit.py +++ b/policyengine_uk/variables/household/consumption/council_tax_less_benefit.py @@ -3,7 +3,13 @@ class council_tax_less_benefit(Variable): label = "Council Tax (less CTB)" - documentation = "Council Tax minus the Council Tax Benefit" + documentation = ( + "Council Tax minus Council Tax Benefit / CTR. Kept as a public " + "convenience variable for downstream consumers (e.g. policyengine-app, " + "council-tax-ctr-map, policyengine-uk-data calibration targets) that " + "need the net council tax bill on a single line; not consumed inside " + "the core model itself." + ) entity = Household definition_period = YEAR value_type = float