Skip to content

Commit 61e12a5

Browse files
authored
Document council_tax_less_benefit as a public-facing convenience (#1671) (#1694)
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.
1 parent 72d27b2 commit 61e12a5

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

changelog.d/1671.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

policyengine_uk/variables/household/consumption/council_tax_less_benefit.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33

44
class council_tax_less_benefit(Variable):
55
label = "Council Tax (less CTB)"
6-
documentation = "Council Tax minus the Council Tax Benefit"
6+
documentation = (
7+
"Council Tax minus Council Tax Benefit / CTR. Kept as a public "
8+
"convenience variable for downstream consumers (e.g. policyengine-app, "
9+
"council-tax-ctr-map, policyengine-uk-data calibration targets) that "
10+
"need the net council tax bill on a single line; not consumed inside "
11+
"the core model itself."
12+
)
713
entity = Household
814
definition_period = YEAR
915
value_type = float

0 commit comments

Comments
 (0)