From d7622987e029dbeb82ce4be8c67b199bc441d433 Mon Sep 17 00:00:00 2001 From: Vahid Ahmadi Date: Wed, 27 May 2026 09:35:34 +0200 Subject: [PATCH] Document council_tax_less_benefit as a public-facing convenience (#1671) Audit per #1671: the variable is unused inside policyengine_uk/ but is consumed by several sibling repos (policyengine-app countries.js, council-tax-ctr-map backend, policyengine-uk-data calibration targets, and structural-reforms-demo). Keep it, and make its public-facing role explicit in the docstring so future audits don't flag it again. --- changelog.d/1671.md | 1 + .../household/consumption/council_tax_less_benefit.py | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 changelog.d/1671.md 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