From 820f58f53702eb8fdc656c2e7f89097b4c9a576d Mon Sep 17 00:00:00 2001 From: Vahid Ahmadi Date: Wed, 6 May 2026 12:29:15 +0100 Subject: [PATCH] Test parameter description punctuation, fix 178 violations (#340) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds `policyengine_uk/tests/test_parameter_descriptions.py` which asserts every parameter `description` ends with a period — and brings the existing 178 parameter files into compliance. Multi-line descriptions are handled by appending the period to the last continuation line so the sentence ends correctly when YAML joins them. Per #339, these descriptions surface in the UI and were inconsistent; locking the convention in CI prevents drift going forward. Co-Authored-By: Claude Opus 4.7 (1M context) --- changelog.d/340.md | 1 + .../parameters/gov/benefit_uprating_cpi.yaml | 2 +- .../parameters/gov/boe/base_rate.yaml | 2 +- .../adult_dependants_grant/income_limit.yaml | 2 +- .../dfe/adult_dependants_grant/maximum.yaml | 2 +- .../other_adult_income_limit.yaml | 2 +- .../gov/dwp/ESA/eligibility/min_age.yaml | 2 +- .../gov/dwp/ESA/income/amount_18_24.yaml | 2 +- .../gov/dwp/ESA/income/amount_over_25.yaml | 2 +- .../parameters/gov/dwp/ESA/income/couple.yaml | 2 +- .../gov/dwp/ESA/income/earn_disregard.yaml | 2 +- .../ESA/income/income_disregard_couple.yaml | 2 +- .../income/income_disregard_lone_parent.yaml | 2 +- .../ESA/income/income_disregard_single.yaml | 2 +- .../gov/dwp/ESA/income/pension_disregard.yaml | 2 +- .../parameters/gov/dwp/IIDB/maximum.yaml | 2 +- .../gov/dwp/JSA/contrib/amount_18_24.yaml | 2 +- .../gov/dwp/JSA/contrib/amount_over_25.yaml | 2 +- .../gov/dwp/JSA/contrib/earn_disregard.yaml | 2 +- .../dwp/JSA/contrib/pension_disregard.yaml | 2 +- .../gov/dwp/JSA/eligibility/min_age.yaml | 2 +- .../parameters/gov/dwp/JSA/hours/couple.yaml | 2 +- .../parameters/gov/dwp/JSA/hours/single.yaml | 2 +- .../gov/dwp/JSA/income/amount_18_24.yaml | 2 +- .../gov/dwp/JSA/income/amount_over_25.yaml | 2 +- .../parameters/gov/dwp/JSA/income/couple.yaml | 2 +- .../JSA/income/income_disregard_couple.yaml | 2 +- .../income/income_disregard_lone_parent.yaml | 2 +- .../JSA/income/income_disregard_single.yaml | 2 +- .../parameters/gov/dwp/JSA/income/takeup.yaml | 2 +- .../dwp/LHA/means_test/earn_disregard.yaml | 2 +- .../means_test/income_disregard_couple.yaml | 2 +- .../LHA/means_test/income_disregard_lone.yaml | 2 +- .../income_disregard_lone_parent.yaml | 2 +- .../means_test/income_disregard_single.yaml | 2 +- .../dwp/LHA/means_test/pension_disregard.yaml | 2 +- .../dwp/LHA/means_test/withdrawal_rate.yaml | 2 +- .../gov/dwp/LHA/means_test/worker_hours.yaml | 2 +- .../means_test/worker_income_disregard.yaml | 2 +- .../shared_accommodation_age_threshold.yaml | 2 +- .../parameters/gov/dwp/benefit_cap.yaml | 2 +- .../exceptional_rate.yaml | 2 +- .../full_day_rate.yaml | 2 +- .../intermediate_rate.yaml | 2 +- .../part_day_rate.yaml | 2 +- .../disability_premia/disability_couple.yaml | 2 +- .../disability_premia/disability_single.yaml | 2 +- .../disability_premia/enhanced_couple.yaml | 2 +- .../disability_premia/enhanced_single.yaml | 2 +- .../dwp/disability_premia/severe_couple.yaml | 2 +- .../dwp/disability_premia/severe_single.yaml | 2 +- .../income_support/amounts/amount_16_24.yaml | 2 +- .../amounts/amount_couples_16_17.yaml | 2 +- .../amounts/amount_couples_age_gap.yaml | 2 +- .../amounts/amount_couples_over_18.yaml | 2 +- .../amounts/amount_lone_16_17.yaml | 2 +- .../amounts/amount_lone_over_18.yaml | 2 +- .../amounts/amount_over_25.yaml | 2 +- .../means_test/earn_disregard.yaml | 2 +- .../means_test/income_disregard_couple.yaml | 2 +- .../income_disregard_lone_parent.yaml | 2 +- .../means_test/income_disregard_single.yaml | 2 +- .../means_test/pension_disregard.yaml | 2 +- .../guarantee_credit/minimum_guarantee.yaml | 2 +- .../savings_credit/threshold.yaml | 2 +- .../gov/dwp/state_pension/age/female.yaml | 2 +- .../gov/dwp/state_pension/age/male.yaml | 2 +- .../elements/child_element.yaml | 2 +- .../elements/dis_child_element.yaml | 2 +- .../elements/family_element.yaml | 2 +- .../elements/severe_dis_child_element.yaml | 2 +- .../child_tax_credit/limit/child_count.yaml | 2 +- .../child_tax_credit/limit/start_year.yaml | 2 +- .../means_test/income_threshold.yaml | 2 +- .../means_test/income_threshold_CTC_only.yaml | 2 +- .../means_test/non_earned_disregard.yaml | 2 +- .../gov/dwp/tax_credits/min_benefit.yaml | 2 +- .../working_tax_credit/elements/basic.yaml | 2 +- .../elements/childcare_1.yaml | 2 +- .../elements/childcare_2.yaml | 2 +- .../elements/childcare_coverage.yaml | 2 +- .../working_tax_credit/elements/couple.yaml | 2 +- .../working_tax_credit/elements/disabled.yaml | 2 +- .../elements/lone_parent.yaml | 2 +- .../elements/severely_disabled.yaml | 2 +- .../working_tax_credit/elements/worker.yaml | 2 +- .../min_hours/couple_with_children.yaml | 2 +- .../working_tax_credit/min_hours/default.yaml | 2 +- .../working_tax_credit/min_hours/lower.yaml | 2 +- .../working_tax_credit/min_hours/old_age.yaml | 2 +- .../means_test/work_allowance.yaml | 2 +- .../dwp/universal_credit/rollout_rate.yaml | 2 +- .../hmrc/child_benefit/amount/additional.yaml | 2 +- .../gov/hmrc/child_benefit/amount/eldest.yaml | 2 +- .../gov/hmrc/child_benefit/takeup/by_age.yaml | 2 +- .../hmrc/child_benefit/takeup/overall.yaml | 2 +- .../adjusted_net_income_components.yaml | 2 +- .../allowances/annual_allowance/default.yaml | 2 +- .../allowances/annual_allowance/minimum.yaml | 2 +- .../annual_allowance/reduction_rate.yaml | 2 +- .../allowances/annual_allowance/taper.yaml | 2 +- .../allowances/dividend_allowance.yaml | 2 +- .../allowances/marriage_allowance/max.yaml | 2 +- .../deduction_rate.yaml | 2 +- .../allowances/personal_allowance/amount.yaml | 2 +- .../personal_allowance/maximum_ANI.yaml | 2 +- .../personal_allowance/reduction_rate.yaml | 2 +- .../additional.yaml | 2 +- .../personal_savings_allowance/basic.yaml | 2 +- .../personal_savings_allowance/higher.yaml | 2 +- .../allowances/property_allowance.yaml | 2 +- .../allowances/trading_allowance.yaml | 2 +- ...ble_self_employment_income_deductions.yaml | 2 +- .../charges/CB_HITC/phase_out_end.yaml | 2 +- .../charges/CB_HITC/phase_out_start.yaml | 2 +- .../earned_taxable_income_exclusions.yaml | 2 +- .../hmrc/income_tax/income_tax_additions.yaml | 2 +- .../income_tax/income_tax_subtractions.yaml | 2 +- .../rates/savings_starter_rate/allowance.yaml | 2 +- .../rates/savings_starter_rate/phase_out.yaml | 2 +- .../hmrc/income_tax/rates/scotland/rates.yaml | 2 +- .../gov/hmrc/income_tax/rates/uk.yaml | 2 +- .../pension_contribution/basic_amount.yaml | 2 +- .../gov/hmrc/minimum_wage/apprentice.yaml | 2 +- .../gov/hmrc/minimum_wage/non_apprentice.yaml | 2 +- .../class_1/rates/employee/additional.yaml | 2 +- .../class_1/rates/employee/main.yaml | 2 +- .../class_1/rates/employer.yaml | 2 +- .../thresholds/lower_earnings_limit.yaml | 2 +- .../class_1/thresholds/primary_threshold.yaml | 2 +- .../thresholds/secondary_threshold.yaml | 2 +- .../thresholds/upper_earnings_limit.yaml | 2 +- .../national_insurance/class_2/flat_rate.yaml | 2 +- .../class_2/small_profits_threshold.yaml | 2 +- .../class_4/rates/additional.yaml | 2 +- .../class_4/rates/main.yaml | 2 +- .../thresholds/lower_profits_limit.yaml | 2 +- .../thresholds/upper_profits_limit.yaml | 2 +- .../gov/hmrc/pensions/pensions_programs.yaml | 2 +- .../stamp_duty/non_residential/purchase.yaml | 2 +- .../hmrc/stamp_duty/non_residential/rent.yaml | 2 +- .../residential/purchase/additional/min.yaml | 2 +- .../residential/purchase/additional/rate.yaml | 2 +- .../residential/purchase/main/first/rate.yaml | 2 +- .../residential/purchase/main/subsequent.yaml | 2 +- .../gov/hmrc/stamp_duty/residential/rent.yaml | 2 +- .../gov/hmrc/stamp_duty/statistics.yaml | 2 +- .../student_loans/interest_rates/index.yaml | 2 +- .../interest_rates/plan_1/boe_margin.yaml | 2 +- .../plan_2/additional_rate.yaml | 2 +- .../interest_rates/plan_2/index.yaml | 2 +- .../plan_2/upper_threshold.yaml | 2 +- .../postgraduate_additional_rate.yaml | 2 +- .../lbtt/non_residential.yaml | 2 +- .../gov/revenue_scotland/lbtt/rent.yaml | 2 +- .../lbtt/residential/rate.yaml | 2 +- .../simulation/microdata_vat_coverage.yaml | 2 +- .../private_school_factor.yaml | 2 +- .../private_school_fees.yaml | 2 +- .../private_school_vat_basis.yaml | 2 +- .../land_transaction_tax/non_residential.yaml | 2 +- .../gov/wra/land_transaction_tax/rent.yaml | 2 +- .../residential/higher_rate.yaml | 2 +- .../residential/primary.yaml | 2 +- .../consumption/carbon/consumption.yaml | 2 +- .../consumption/carbon/emissions.yaml | 2 +- .../consumption/carbon/production.yaml | 2 +- .../demographic/equiv/ahc/child_over_14.yaml | 2 +- .../demographic/equiv/ahc/child_under_14.yaml | 2 +- .../demographic/equiv/ahc/first_adult.yaml | 2 +- .../demographic/equiv/ahc/second_adult.yaml | 2 +- .../demographic/equiv/bhc/child_over_14.yaml | 2 +- .../demographic/equiv/bhc/child_under_14.yaml | 2 +- .../demographic/equiv/bhc/first_adult.yaml | 2 +- .../demographic/equiv/bhc/second_adult.yaml | 2 +- .../absolute_poverty_threshold_bhc.yaml | 2 +- .../poverty/exclude_non_hbai_income.yaml | 2 +- .../household/wealth/land/intensity.yaml | 2 +- .../wealth/national_balance_sheet.yaml | 2 +- .../tests/test_parameter_descriptions.py | 45 +++++++++++++++++++ 180 files changed, 224 insertions(+), 178 deletions(-) create mode 100644 changelog.d/340.md create mode 100644 policyengine_uk/tests/test_parameter_descriptions.py diff --git a/changelog.d/340.md b/changelog.d/340.md new file mode 100644 index 000000000..625459d6a --- /dev/null +++ b/changelog.d/340.md @@ -0,0 +1 @@ +- Add a structural test that every parameter description ends with a period, and bring the existing 178 parameter files into compliance. diff --git a/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml b/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml index e46eb35ad..ddf58c5e8 100644 --- a/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml +++ b/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml @@ -1,4 +1,4 @@ -description: Most recent September CPIH index value, updated for each uprating occurrence (2005=100) +description: Most recent September CPIH index value, updated for each uprating occurrence (2005=100). values: 2005-01-01: 100 2010-01-01: 114.48 diff --git a/policyengine_uk/parameters/gov/boe/base_rate.yaml b/policyengine_uk/parameters/gov/boe/base_rate.yaml index 964e506d0..300dba19b 100644 --- a/policyengine_uk/parameters/gov/boe/base_rate.yaml +++ b/policyengine_uk/parameters/gov/boe/base_rate.yaml @@ -1,4 +1,4 @@ -description: Bank of England base rate +description: Bank of England base rate. metadata: label: BoE base rate unit: /1 diff --git a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/income_limit.yaml b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/income_limit.yaml index a3bdf9774..dc7800e93 100644 --- a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/income_limit.yaml +++ b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/income_limit.yaml @@ -1,4 +1,4 @@ -description: Household income limit for Adult Dependants' Grant +description: Household income limit for Adult Dependants' Grant. metadata: label: Adult Dependants' Grant household income limit unit: currency-GBP diff --git a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/maximum.yaml b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/maximum.yaml index 0aa4f7ce2..609499453 100644 --- a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/maximum.yaml +++ b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/maximum.yaml @@ -1,4 +1,4 @@ -description: Maximum Adult Dependants' Grant amount +description: Maximum Adult Dependants' Grant amount. metadata: label: Adult Dependants' Grant maximum unit: currency-GBP diff --git a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/other_adult_income_limit.yaml b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/other_adult_income_limit.yaml index 16295a645..ef6eee85d 100644 --- a/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/other_adult_income_limit.yaml +++ b/policyengine_uk/parameters/gov/dfe/adult_dependants_grant/other_adult_income_limit.yaml @@ -1,4 +1,4 @@ -description: Income limit for a non-partner adult dependant in the Adult Dependants' Grant assessment +description: Income limit for a non-partner adult dependant in the Adult Dependants' Grant assessment. metadata: label: Adult Dependants' Grant other adult income limit unit: currency-GBP diff --git a/policyengine_uk/parameters/gov/dwp/ESA/eligibility/min_age.yaml b/policyengine_uk/parameters/gov/dwp/ESA/eligibility/min_age.yaml index dc4b19e04..d2fd42e8a 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/eligibility/min_age.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/eligibility/min_age.yaml @@ -1,4 +1,4 @@ -description: Minimum age for Employment and Support Allowance +description: Minimum age for Employment and Support Allowance. metadata: unit: year period: year diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/amount_18_24.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/amount_18_24.yaml index e56108988..14473f9e9 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/amount_18_24.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/amount_18_24.yaml @@ -1,5 +1,5 @@ description: Income-based Employment and Support Allowance personal allowance for - persons aged 18-24 + persons aged 18-24. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/amount_over_25.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/amount_over_25.yaml index bb4340e77..e75a5e2e9 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/amount_over_25.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/amount_over_25.yaml @@ -1,5 +1,5 @@ description: Income-based Employment and Support Allowance personal allowance for - persons aged over 25 + persons aged over 25. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/couple.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/couple.yaml index c3782e3e1..a0f446e13 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/couple.yaml @@ -1,5 +1,5 @@ description: Income-based Employment and Support Allowance personal allowance for - couples + couples. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/earn_disregard.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/earn_disregard.yaml index e2c103df8..a28be666b 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/earn_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/earn_disregard.yaml @@ -1,5 +1,5 @@ description: Earnings threshold above which the income-based Employment and Support - Allowance amount is reduced + Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_couple.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_couple.yaml index a5ce62ba8..dd3de63ac 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_couple.yaml @@ -1,5 +1,5 @@ description: Threshold for income for a couple, above which the income-based Employment - and Support Allowance amount is reduced + and Support Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_lone_parent.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_lone_parent.yaml index 02e9cb645..77ce71ee4 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_lone_parent.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_lone_parent.yaml @@ -1,5 +1,5 @@ description: Threshold for income for a lone parent, above which the income-based - Employment and Support Allowance amount is reduced + Employment and Support Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_single.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_single.yaml index 56c18b3a6..3dd7e84a3 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/income_disregard_single.yaml @@ -1,5 +1,5 @@ description: Threshold for income for a single person, above which the income-based - Employment and Support Allowance amount is reduced + Employment and Support Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/ESA/income/pension_disregard.yaml b/policyengine_uk/parameters/gov/dwp/ESA/income/pension_disregard.yaml index ff7b1edf4..83bd69334 100644 --- a/policyengine_uk/parameters/gov/dwp/ESA/income/pension_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/ESA/income/pension_disregard.yaml @@ -1,5 +1,5 @@ description: Threshold for occupational and personal pensions, above which the income-based - Employment and Support Allowance amount is reduced + Employment and Support Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/IIDB/maximum.yaml b/policyengine_uk/parameters/gov/dwp/IIDB/maximum.yaml index d418ee90b..de90f050b 100644 --- a/policyengine_uk/parameters/gov/dwp/IIDB/maximum.yaml +++ b/policyengine_uk/parameters/gov/dwp/IIDB/maximum.yaml @@ -1,5 +1,5 @@ description: Maximum weekly Industrial Injuries Disablement Benefit; amount varies - in 10% increments + in 10% increments. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_18_24.yaml b/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_18_24.yaml index 0b12e379e..43681e068 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_18_24.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_18_24.yaml @@ -1,4 +1,4 @@ -description: Income-based Jobseeker's Allowance for persons aged 18-24 +description: Income-based Jobseeker's Allowance for persons aged 18-24. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_over_25.yaml b/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_over_25.yaml index 8a07330ba..786510d49 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_over_25.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/contrib/amount_over_25.yaml @@ -1,4 +1,4 @@ -description: Contributory Jobseeker's Allowance for persons aged over 25 +description: Contributory Jobseeker's Allowance for persons aged over 25. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/contrib/earn_disregard.yaml b/policyengine_uk/parameters/gov/dwp/JSA/contrib/earn_disregard.yaml index 8fe25f3a1..12c2d0566 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/contrib/earn_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/contrib/earn_disregard.yaml @@ -1,5 +1,5 @@ description: Threshold in earnings, above which the contributory Jobseeker's Allowance - amount is reduced + amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/contrib/pension_disregard.yaml b/policyengine_uk/parameters/gov/dwp/JSA/contrib/pension_disregard.yaml index b8a03f2b3..50a8265cd 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/contrib/pension_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/contrib/pension_disregard.yaml @@ -1,5 +1,5 @@ description: Threshold in occupational and personal pensions, above which the contributory - Jobseeker's Allowance amount is reduced + Jobseeker's Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/eligibility/min_age.yaml b/policyengine_uk/parameters/gov/dwp/JSA/eligibility/min_age.yaml index ab2c0c139..7729fa752 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/eligibility/min_age.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/eligibility/min_age.yaml @@ -1,4 +1,4 @@ -description: Default minimum age for income-based Jobseeker's Allowance +description: Default minimum age for income-based Jobseeker's Allowance. metadata: unit: year period: year diff --git a/policyengine_uk/parameters/gov/dwp/JSA/hours/couple.yaml b/policyengine_uk/parameters/gov/dwp/JSA/hours/couple.yaml index a29130db9..eb295e174 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/hours/couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/hours/couple.yaml @@ -1,4 +1,4 @@ -description: Hours requirement for joint claimants of Jobseeker's Allowance +description: Hours requirement for joint claimants of Jobseeker's Allowance. values: 2015-04-01: value: 24 diff --git a/policyengine_uk/parameters/gov/dwp/JSA/hours/single.yaml b/policyengine_uk/parameters/gov/dwp/JSA/hours/single.yaml index c32fe623e..a5b4d47ce 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/hours/single.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/hours/single.yaml @@ -1,4 +1,4 @@ -description: Hours requirement for single claimants of Jobseeker's Allowance +description: Hours requirement for single claimants of Jobseeker's Allowance. values: 2015-04-01: value: 16 diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/amount_18_24.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/amount_18_24.yaml index 5ea07d888..7be4b614f 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/amount_18_24.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/amount_18_24.yaml @@ -1,4 +1,4 @@ -description: Income-based Jobseeker's Allowance for persons aged 18-24 +description: Income-based Jobseeker's Allowance for persons aged 18-24. values: 2015-04-01: 57.9 2016-04-01: 57.9 diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/amount_over_25.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/amount_over_25.yaml index 9918732bc..9f5075286 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/amount_over_25.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/amount_over_25.yaml @@ -1,4 +1,4 @@ -description: Income-based Jobseeker's Allowance for persons aged over 25 +description: Income-based Jobseeker's Allowance for persons aged over 25. values: 2015-04-01: 73.1 2016-04-01: 73.1 diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/couple.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/couple.yaml index e8da69c4d..5bd7a55d1 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/couple.yaml @@ -1,4 +1,4 @@ -description: Weekly contributory Jobseeker's Allowance for couples +description: Weekly contributory Jobseeker's Allowance for couples. values: 2015-04-01: 114.85 2016-04-01: 114.85 diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_couple.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_couple.yaml index 09a749bb0..95a840e17 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_couple.yaml @@ -1,4 +1,4 @@ -description: Threshold in income for a couple, above which the contributory Jobseeker's Allowance amount is reduced +description: Threshold in income for a couple, above which the contributory Jobseeker's Allowance amount is reduced. values: 2015-04-01: 10 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_lone_parent.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_lone_parent.yaml index 7688ecdc6..74cf3657e 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_lone_parent.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_lone_parent.yaml @@ -1,5 +1,5 @@ description: Threshold in income for a lone parent, above which the contributory Jobseeker's - Allowance amount is reduced + Allowance amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_single.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_single.yaml index 0c41e6189..62cbd2415 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/income_disregard_single.yaml @@ -1,4 +1,4 @@ -description: Threshold in income for a single person, above which the Jobseeker's Allowance amount is reduced +description: Threshold in income for a single person, above which the Jobseeker's Allowance amount is reduced. values: 2015-04-01: 5 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/JSA/income/takeup.yaml b/policyengine_uk/parameters/gov/dwp/JSA/income/takeup.yaml index 75ff37fca..ae5a9338b 100644 --- a/policyengine_uk/parameters/gov/dwp/JSA/income/takeup.yaml +++ b/policyengine_uk/parameters/gov/dwp/JSA/income/takeup.yaml @@ -1,5 +1,5 @@ description: Share of eligible Income-based Jobseeker's Allowance recipients that - participate + participate. metadata: economy: false label: Income-based Jobseeker's Allowance take-up rate diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/earn_disregard.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/earn_disregard.yaml index 2ddba0d28..0dd9a6193 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/earn_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/earn_disregard.yaml @@ -1,4 +1,4 @@ -description: Threshold earnings, above which the Housing Benefit (LHA) is reduced +description: Threshold earnings, above which the Housing Benefit (LHA) is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_couple.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_couple.yaml index adb51cad9..02a2b68fe 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_couple.yaml @@ -1,5 +1,5 @@ description: Threshold in income for a couple, above which the Housing Benefit (LHA) - amount is reduced + amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone.yaml index 575074889..4eba85689 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone.yaml @@ -1,5 +1,5 @@ description: Threshold in income for a lone parent, above which the Housing Benefit - (LHA) amount is reduced + (LHA) amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone_parent.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone_parent.yaml index 575074889..4eba85689 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone_parent.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_lone_parent.yaml @@ -1,5 +1,5 @@ description: Threshold in income for a lone parent, above which the Housing Benefit - (LHA) amount is reduced + (LHA) amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_single.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_single.yaml index f88bb708c..4b204fae6 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/income_disregard_single.yaml @@ -1,5 +1,5 @@ description: Threshold in income for a single person, above which the Housing Benefit - (LHA) amount is reduced + (LHA) amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/pension_disregard.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/pension_disregard.yaml index a2f981bf5..8c2b9afdb 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/pension_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/pension_disregard.yaml @@ -1,5 +1,5 @@ description: Threshold in occupational and personal pensions, above which the Housing - Benefit (LHA) amount is reduced + Benefit (LHA) amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/withdrawal_rate.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/withdrawal_rate.yaml index 9b6daf3eb..c3fd75143 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/withdrawal_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/withdrawal_rate.yaml @@ -1,4 +1,4 @@ -description: Withdrawal rate of Housing Benefit (LHA) +description: Withdrawal rate of Housing Benefit (LHA). metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_hours.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_hours.yaml index f321a9c2c..e491a577f 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_hours.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_hours.yaml @@ -1,5 +1,5 @@ description: Default hours requirement for the Working-Tax-Credit-related worker element - of Housing Benefit (LHA) + of Housing Benefit (LHA). metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_income_disregard.yaml b/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_income_disregard.yaml index 404785e65..7cc89cd30 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_income_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/means_test/worker_income_disregard.yaml @@ -1,4 +1,4 @@ -description: Additional disregard in income for meeting the 16/30 hours requirement +description: Additional disregard in income for meeting the 16/30 hours requirement. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/LHA/shared_accommodation_age_threshold.yaml b/policyengine_uk/parameters/gov/dwp/LHA/shared_accommodation_age_threshold.yaml index b6656e109..e47ddeb80 100644 --- a/policyengine_uk/parameters/gov/dwp/LHA/shared_accommodation_age_threshold.yaml +++ b/policyengine_uk/parameters/gov/dwp/LHA/shared_accommodation_age_threshold.yaml @@ -1,4 +1,4 @@ -description: Age threshold below which single adults without children can only claim shared accommodation rates under LHA +description: Age threshold below which single adults without children can only claim shared accommodation rates under LHA. values: 2013-04-01: 35 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/benefit_cap.yaml b/policyengine_uk/parameters/gov/dwp/benefit_cap.yaml index 2bf46a5a0..d5fc18c99 100644 --- a/policyengine_uk/parameters/gov/dwp/benefit_cap.yaml +++ b/policyengine_uk/parameters/gov/dwp/benefit_cap.yaml @@ -1,4 +1,4 @@ -description: Benefit cap +description: Benefit cap. single: metadata: label: Single claimants diff --git a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/exceptional_rate.yaml b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/exceptional_rate.yaml index 76131410c..fb545891c 100644 --- a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/exceptional_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/exceptional_rate.yaml @@ -1,4 +1,4 @@ -description: Exceptional rate for Constant Attendance Allowance +description: Exceptional rate for Constant Attendance Allowance. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/full_day_rate.yaml b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/full_day_rate.yaml index 7b5038da5..bf31a454e 100644 --- a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/full_day_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/full_day_rate.yaml @@ -1,4 +1,4 @@ -description: Full day rate for Constant Attendance Allowance +description: Full day rate for Constant Attendance Allowance. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/intermediate_rate.yaml b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/intermediate_rate.yaml index 36b9a7938..d1a1495fa 100644 --- a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/intermediate_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/intermediate_rate.yaml @@ -1,4 +1,4 @@ -description: Intermediate rate for Constant Attendance Allowance +description: Intermediate rate for Constant Attendance Allowance. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/part_day_rate.yaml b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/part_day_rate.yaml index 73b9775ff..a5839be8a 100644 --- a/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/part_day_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/constant_attendance_allowance/part_day_rate.yaml @@ -1,4 +1,4 @@ -description: Part day rate for Constant Attendance Allowance +description: Part day rate for Constant Attendance Allowance. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/disability_couple.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/disability_couple.yaml index 0587b0253..e725962f2 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/disability_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/disability_couple.yaml @@ -1,4 +1,4 @@ -description: Disability premium for a couple +description: Disability premium for a couple. values: 2015-04-01: 49.8 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/disability_single.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/disability_single.yaml index be063fbd9..2c4993f0d 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/disability_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/disability_single.yaml @@ -1,4 +1,4 @@ -description: Disability premium for a single person +description: Disability premium for a single person. values: 2015-04-01: 34.95 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_couple.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_couple.yaml index 9c5c17a6d..209742507 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_couple.yaml @@ -1,4 +1,4 @@ -description: Enhanced disability premium for a couple, invalid for Employment and Support Allowance +description: Enhanced disability premium for a couple, invalid for Employment and Support Allowance. values: 2015-04-01: 24.5 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_single.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_single.yaml index 8eb7cb1a1..14dc96873 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/enhanced_single.yaml @@ -1,4 +1,4 @@ -description: Enhanced disability premium for a single person, invalid for Employment and Support Allowance +description: Enhanced disability premium for a single person, invalid for Employment and Support Allowance. values: 2015-04-01: 17.1 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/severe_couple.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/severe_couple.yaml index a1c67d973..0107a6d91 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/severe_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/severe_couple.yaml @@ -1,4 +1,4 @@ -description: Severe disability premium for a couple where both are eligible +description: Severe disability premium for a couple where both are eligible. values: 2015-04-01: 133.9 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/disability_premia/severe_single.yaml b/policyengine_uk/parameters/gov/dwp/disability_premia/severe_single.yaml index 585a23079..642e1e0e9 100644 --- a/policyengine_uk/parameters/gov/dwp/disability_premia/severe_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/disability_premia/severe_single.yaml @@ -1,4 +1,4 @@ -description: Severe disability premium for a single person +description: Severe disability premium for a single person. values: 2015-04-01: 66.95 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_16_24.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_16_24.yaml index 85b0b872b..3a6e4fa21 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_16_24.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_16_24.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for single persons aged 18-24 +description: Income Support applicable amount for single persons aged 18-24. values: 2015-04-01: 58.9 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_16_17.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_16_17.yaml index 9fe376866..cdce35478 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_16_17.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_16_17.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for couples both aged under 18 +description: Income Support applicable amount for couples both aged under 18. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_age_gap.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_age_gap.yaml index c8b35ae46..c5fbef891 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_age_gap.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_age_gap.yaml @@ -1,5 +1,5 @@ description: Income Support applicable amount for couples in which one is under 18 - and one over 25 + and one over 25. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_over_18.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_over_18.yaml index 7dc2d4718..0d8d3aa04 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_over_18.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_couples_over_18.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for couples aged over 18 +description: Income Support applicable amount for couples aged over 18. values: 2015-04-01: 116.8 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_16_17.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_16_17.yaml index 168b0819c..20c8bf492 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_16_17.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_16_17.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for lone parents aged under 18 +description: Income Support applicable amount for lone parents aged under 18. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_over_18.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_over_18.yaml index 09cd81ca8..575b6a600 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_over_18.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_lone_over_18.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for lone parents aged over 18 +description: Income Support applicable amount for lone parents aged over 18. values: 2015-04-01: 74.35 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_over_25.yaml b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_over_25.yaml index 326d4c1d7..7fd797c03 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_over_25.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/amounts/amount_over_25.yaml @@ -1,4 +1,4 @@ -description: Income Support applicable amount for single persons aged over 25 +description: Income Support applicable amount for single persons aged over 25. values: 2015-04-01: 74.35 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/means_test/earn_disregard.yaml b/policyengine_uk/parameters/gov/dwp/income_support/means_test/earn_disregard.yaml index 849585678..67faf3e44 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/means_test/earn_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/means_test/earn_disregard.yaml @@ -1,4 +1,4 @@ -description: Threshold in earnings, above which the Income Support amount is reduced +description: Threshold in earnings, above which the Income Support amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_couple.yaml b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_couple.yaml index 220d79a9a..0db0d6eaa 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_couple.yaml @@ -1,4 +1,4 @@ -description: Threshold in income for a couple, above which the Income Support amount is reduced +description: Threshold in income for a couple, above which the Income Support amount is reduced. values: 2015-04-01: 10 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_lone_parent.yaml b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_lone_parent.yaml index 273948762..e1fb40116 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_lone_parent.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_lone_parent.yaml @@ -1,4 +1,4 @@ -description: Threshold in income for a lone parent, above which the Income Support amount is reduced +description: Threshold in income for a lone parent, above which the Income Support amount is reduced. values: 2015-04-01: 20 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_single.yaml b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_single.yaml index ca2f2b989..23a4b7667 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_single.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/means_test/income_disregard_single.yaml @@ -1,4 +1,4 @@ -description: Threshold in income for a single person, above which the Income Support amount is reduced +description: Threshold in income for a single person, above which the Income Support amount is reduced. values: 2015-04-01: 5 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/income_support/means_test/pension_disregard.yaml b/policyengine_uk/parameters/gov/dwp/income_support/means_test/pension_disregard.yaml index 2bb678946..0a51c3af1 100644 --- a/policyengine_uk/parameters/gov/dwp/income_support/means_test/pension_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/income_support/means_test/pension_disregard.yaml @@ -1,5 +1,5 @@ description: Threshold in occupational and personal pensions, above which the Income - Support amount is reduced + Support amount is reduced. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/dwp/pension_credit/guarantee_credit/minimum_guarantee.yaml b/policyengine_uk/parameters/gov/dwp/pension_credit/guarantee_credit/minimum_guarantee.yaml index 95fff49ab..ec5d48488 100644 --- a/policyengine_uk/parameters/gov/dwp/pension_credit/guarantee_credit/minimum_guarantee.yaml +++ b/policyengine_uk/parameters/gov/dwp/pension_credit/guarantee_credit/minimum_guarantee.yaml @@ -1,4 +1,4 @@ -description: Minimum income guarantee (basic amount) for Pension Credit +description: Minimum income guarantee (basic amount) for Pension Credit. SINGLE: values: 2015-04-06: 151.2 diff --git a/policyengine_uk/parameters/gov/dwp/pension_credit/savings_credit/threshold.yaml b/policyengine_uk/parameters/gov/dwp/pension_credit/savings_credit/threshold.yaml index 3882a374c..83f085aa9 100644 --- a/policyengine_uk/parameters/gov/dwp/pension_credit/savings_credit/threshold.yaml +++ b/policyengine_uk/parameters/gov/dwp/pension_credit/savings_credit/threshold.yaml @@ -1,4 +1,4 @@ -description: Income threshold at which Savings Credit is eligible +description: Income threshold at which Savings Credit is eligible. SINGLE: values: 2015-04-06: 126.5 diff --git a/policyengine_uk/parameters/gov/dwp/state_pension/age/female.yaml b/policyengine_uk/parameters/gov/dwp/state_pension/age/female.yaml index cdef4ca9c..84f32f7f9 100644 --- a/policyengine_uk/parameters/gov/dwp/state_pension/age/female.yaml +++ b/policyengine_uk/parameters/gov/dwp/state_pension/age/female.yaml @@ -1,4 +1,4 @@ -description: Female State Pension age +description: Female State Pension age. values: 1950-01-05: 60 2010-01-01: 61 diff --git a/policyengine_uk/parameters/gov/dwp/state_pension/age/male.yaml b/policyengine_uk/parameters/gov/dwp/state_pension/age/male.yaml index 6584383e5..6a9c52842 100644 --- a/policyengine_uk/parameters/gov/dwp/state_pension/age/male.yaml +++ b/policyengine_uk/parameters/gov/dwp/state_pension/age/male.yaml @@ -1,4 +1,4 @@ -description: Male State Pension age +description: Male State Pension age. values: 1950-01-05: 65 2020-01-01: 66 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/child_element.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/child_element.yaml index 91c22a42f..541487786 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/child_element.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/child_element.yaml @@ -1,4 +1,4 @@ -description: Child Tax Credit child element +description: Child Tax Credit child element. values: 2016-04-06: value: 2780 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/dis_child_element.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/dis_child_element.yaml index 8b1a51e0e..de84b54ed 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/dis_child_element.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/dis_child_element.yaml @@ -1,4 +1,4 @@ -description: Child Tax Credit disabled child element +description: Child Tax Credit disabled child element. values: 2015-04-06: value: 3140 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/family_element.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/family_element.yaml index 225530ad0..1031f19d2 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/family_element.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/family_element.yaml @@ -1,4 +1,4 @@ -description: Child Tax Credit family element +description: Child Tax Credit family element. values: 2016-04-06: value: 545 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/severe_dis_child_element.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/severe_dis_child_element.yaml index d5c5ec1b8..7400e2907 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/severe_dis_child_element.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/elements/severe_dis_child_element.yaml @@ -1,4 +1,4 @@ -description: Child Tax Credit severely disabled child element +description: Child Tax Credit severely disabled child element. values: 2016-04-06: value: 1275 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/child_count.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/child_count.yaml index fc7494af7..092b0c744 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/child_count.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/child_count.yaml @@ -1,4 +1,4 @@ -description: Limit on the number of children for which the Child Tax Credit child element is payable +description: Limit on the number of children for which the Child Tax Credit child element is payable. values: 0001-01-01: .inf 2017-04-06: 2 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/start_year.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/start_year.yaml index f8b192326..a59e4dd07 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/start_year.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/child_tax_credit/limit/start_year.yaml @@ -1,4 +1,4 @@ -description: Year in which the Child Tax Credit child limit applies +description: Year in which the Child Tax Credit child limit applies. values: 0001-01-01: 2017 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold.yaml index eda8f669f..8cf2d32ae 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold.yaml @@ -1,4 +1,4 @@ -description: Yearly income threshold after which the Child Tax Credit is reduced for benefit units claiming Working Tax Credit +description: Yearly income threshold after which the Child Tax Credit is reduced for benefit units claiming Working Tax Credit. values: 2016-04-06: 6_420 # NB: EUROMOD reports 6_555 for 2020. This is the gov.uk value. diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold_CTC_only.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold_CTC_only.yaml index cab47987c..287734a82 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold_CTC_only.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/income_threshold_CTC_only.yaml @@ -1,4 +1,4 @@ -description: Income threshold for benefit units only entitled to Child Tax Credit +description: Income threshold for benefit units only entitled to Child Tax Credit. values: 2016-04-06: 16_105 # NB: EUROMOD reports 16_435 for 2020. This is the gov.uk value. diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/non_earned_disregard.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/non_earned_disregard.yaml index 11aff0c24..fd09d03ce 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/non_earned_disregard.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/means_test/non_earned_disregard.yaml @@ -1,4 +1,4 @@ -description: Amount of income from non-earned sources disregarded in the tax credit income test +description: Amount of income from non-earned sources disregarded in the tax credit income test. values: 2002-04-01: 300 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/min_benefit.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/min_benefit.yaml index 363e315d7..65a2303f7 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/min_benefit.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/min_benefit.yaml @@ -1,4 +1,4 @@ -description: Tax credit amount below which tax credits are not paid +description: Tax credit amount below which tax credits are not paid. metadata: economy: false label: Tax credits minimum benefit diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/basic.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/basic.yaml index 0af6edf27..d5a6d7c3d 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/basic.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/basic.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit basic element +description: Working Tax Credit basic element. values: 2002-08-01: 1_525 2004-04-06: 1_570 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_1.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_1.yaml index bebc0d5b3..a7ae7a75b 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_1.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_1.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit childcare element for one child +description: Working Tax Credit childcare element for one child. values: 2002-08-01: 135 2005-04-06: 175 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_2.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_2.yaml index 19dcb230a..4f42a4ee7 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_2.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_2.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit childcare element for two or more children +description: Working Tax Credit childcare element for two or more children. values: 2002-08-01: 200 2005-04-06: 300 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_coverage.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_coverage.yaml index b672544ab..372fbd2e8 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_coverage.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/childcare_coverage.yaml @@ -1,4 +1,4 @@ -description: Proportion of eligible childcare costs covered by Working Tax Credit +description: Proportion of eligible childcare costs covered by Working Tax Credit. values: 2002-08-01: 0.7 2006-04-06: 0.8 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/couple.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/couple.yaml index 7348bfcf9..8f005b5f1 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/couple.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/couple.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit couple element +description: Working Tax Credit couple element. values: 2002-08-01: 1_500 2004-04-06: 1_545 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/disabled.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/disabled.yaml index 285f4b012..da0ce80d4 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/disabled.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/disabled.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit disability element +description: Working Tax Credit disability element. values: 2002-08-01: 2_040 2004-04-06: 2_100 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/lone_parent.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/lone_parent.yaml index 98929209a..07cb701ff 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/lone_parent.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/lone_parent.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit lone parent element +description: Working Tax Credit lone parent element. values: 2002-08-01: 1_500 2004-04-06: 1_545 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/severely_disabled.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/severely_disabled.yaml index eb90b54ee..c58d9ea61 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/severely_disabled.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/severely_disabled.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit severe disability element +description: Working Tax Credit severe disability element. values: 2002-08-01: 865 2004-04-06: 890 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/worker.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/worker.yaml index 9a18e3784..c4e18d98d 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/worker.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/elements/worker.yaml @@ -1,4 +1,4 @@ -description: Working Tax Credit 30 hours element +description: Working Tax Credit 30 hours element. values: 2002-08-01: 620 2004-04-06: 640 diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/couple_with_children.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/couple_with_children.yaml index 91aac364d..2df48c1e3 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/couple_with_children.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/couple_with_children.yaml @@ -1,4 +1,4 @@ -description: Couple with children hours requirement for Working Tax Credit +description: Couple with children hours requirement for Working Tax Credit. values: 2012-04-06: 24 # No special rule prior to 2012. metadata: diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/default.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/default.yaml index 28b218b0c..417c29a80 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/default.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/default.yaml @@ -1,4 +1,4 @@ -description: Default hours requirement for Working Tax Credit +description: Default hours requirement for Working Tax Credit. values: 2002-08-01: 30 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/lower.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/lower.yaml index 918a53b5e..6dfb004a5 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/lower.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/lower.yaml @@ -1,4 +1,4 @@ -description: Lower hours requirement for Working Tax Credit +description: Lower hours requirement for Working Tax Credit. values: 2002-08-01: 16 metadata: diff --git a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/old_age.yaml b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/old_age.yaml index 62fd7cad5..76f192f8b 100644 --- a/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/old_age.yaml +++ b/policyengine_uk/parameters/gov/dwp/tax_credits/working_tax_credit/min_hours/old_age.yaml @@ -1,4 +1,4 @@ -description: Age for lower hours requirement for Working Tax Credit +description: Age for lower hours requirement for Working Tax Credit. values: 2002-08-01: .inf # Special old-age rule introduced in 2011. 2011-04-06: 60 diff --git a/policyengine_uk/parameters/gov/dwp/universal_credit/means_test/work_allowance.yaml b/policyengine_uk/parameters/gov/dwp/universal_credit/means_test/work_allowance.yaml index df847e8ec..3946900bd 100644 --- a/policyengine_uk/parameters/gov/dwp/universal_credit/means_test/work_allowance.yaml +++ b/policyengine_uk/parameters/gov/dwp/universal_credit/means_test/work_allowance.yaml @@ -1,4 +1,4 @@ -description: Universal Credit work allowance +description: Universal Credit work allowance. metadata: label: Universal Credit work allowance period: month diff --git a/policyengine_uk/parameters/gov/dwp/universal_credit/rollout_rate.yaml b/policyengine_uk/parameters/gov/dwp/universal_credit/rollout_rate.yaml index f93040664..fd54064ab 100644 --- a/policyengine_uk/parameters/gov/dwp/universal_credit/rollout_rate.yaml +++ b/policyengine_uk/parameters/gov/dwp/universal_credit/rollout_rate.yaml @@ -1,4 +1,4 @@ -description: Roll-out rate of Universal Credit +description: Roll-out rate of Universal Credit. metadata: economy: false propagate_metadata_to_children: true diff --git a/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/additional.yaml b/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/additional.yaml index d445cf983..1c3dbde82 100644 --- a/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/additional.yaml +++ b/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/additional.yaml @@ -1,4 +1,4 @@ -description: Child Benefit amount for each additional child +description: Child Benefit amount for each additional child. values: 2007-04-09: value: 12.1 diff --git a/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/eldest.yaml b/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/eldest.yaml index 1932d4911..89012df10 100644 --- a/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/eldest.yaml +++ b/policyengine_uk/parameters/gov/hmrc/child_benefit/amount/eldest.yaml @@ -1,4 +1,4 @@ -description: Child Benefit amount for the eldest or only child +description: Child Benefit amount for the eldest or only child. values: 2007-04-09: value: 18.8 diff --git a/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/by_age.yaml b/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/by_age.yaml index 0c32227ab..47a3b273a 100644 --- a/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/by_age.yaml +++ b/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/by_age.yaml @@ -1,4 +1,4 @@ -description: Share of eligible Child Benefit recipients that participate, by age +description: Share of eligible Child Benefit recipients that participate, by age. brackets: - threshold: 2022-01-01: 0 diff --git a/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/overall.yaml b/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/overall.yaml index a64307f08..8322a474d 100644 --- a/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/overall.yaml +++ b/policyengine_uk/parameters/gov/hmrc/child_benefit/takeup/overall.yaml @@ -1,4 +1,4 @@ -description: Share of eligible children that participate in Child Benefit +description: Share of eligible children that participate in Child Benefit. values: 2012-01-01: 0.97 2022-01-01: 0.89 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/adjusted_net_income_components.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/adjusted_net_income_components.yaml index 08a81e0c8..c6604cd0a 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/adjusted_net_income_components.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/adjusted_net_income_components.yaml @@ -1,4 +1,4 @@ -description: Components of adjusted net income +description: Components of adjusted net income. values: 0000-01-01: - taxable_employment_income diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/default.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/default.yaml index d79fe8387..19ab2ac20 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/default.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/default.yaml @@ -1,4 +1,4 @@ -description: Annual allowance for relief on pension contributions +description: Annual allowance for relief on pension contributions. values: 2015-04-01: 40_000 2023-04-06: 60_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/minimum.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/minimum.yaml index f8d972ea1..ad1862cfc 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/minimum.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/minimum.yaml @@ -1,4 +1,4 @@ -description: Minimum annual allowance for relief on pension contributions +description: Minimum annual allowance for relief on pension contributions. values: 2015-04-01: 4_000 2023-04-06: 10_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/reduction_rate.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/reduction_rate.yaml index c7d43fc80..a226d1487 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/reduction_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/reduction_rate.yaml @@ -1,4 +1,4 @@ -description: Reduction rate for the annual allowance +description: Reduction rate for the annual allowance. values: 2015-04-01: 0.5 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/taper.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/taper.yaml index 60e897ed2..72835cd44 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/taper.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/annual_allowance/taper.yaml @@ -1,4 +1,4 @@ -description: Adjusted net income limit for tapering of the annual allowance +description: Adjusted net income limit for tapering of the annual allowance. values: 2015-04-01: 240_000 2023-04-06: 260_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/dividend_allowance.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/dividend_allowance.yaml index 6efb54084..0759e8ea6 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/dividend_allowance.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/dividend_allowance.yaml @@ -1,4 +1,4 @@ -description: Amount of dividend income untaxed per year +description: Amount of dividend income untaxed per year. values: 2016-04-06: value: 5_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/marriage_allowance/max.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/marriage_allowance/max.yaml index b39f3c292..bbde24b1b 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/marriage_allowance/max.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/marriage_allowance/max.yaml @@ -1,4 +1,4 @@ -description: Maximum Marriage Allowance taxable income reduction, as a percentage of the full Personal Allowance +description: Maximum Marriage Allowance taxable income reduction, as a percentage of the full Personal Allowance. values: 2016-04-01: 0.1 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/married_couples_allowance/deduction_rate.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/married_couples_allowance/deduction_rate.yaml index c1991c16f..9c1211ffe 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/married_couples_allowance/deduction_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/married_couples_allowance/deduction_rate.yaml @@ -1,5 +1,5 @@ description: Percentage of the Married Couple's Allowance which is deductible from - Income Tax Liability + Income Tax Liability. metadata: economy: false propagate_metadata_to_children: true diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/amount.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/amount.yaml index a1ec9e0ee..10221e70f 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/amount.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/amount.yaml @@ -1,4 +1,4 @@ -description: The Personal Allowance is deducted from general income +description: The Personal Allowance is deducted from general income. values: 2015-04-06: 10_600 2017-04-06: 11_500 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/maximum_ANI.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/maximum_ANI.yaml index 1d206c659..945865df7 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/maximum_ANI.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/maximum_ANI.yaml @@ -1,4 +1,4 @@ -description: Maximum adjusted net income before the Personal Allowance is reduced +description: Maximum adjusted net income before the Personal Allowance is reduced. values: # Date legislation passed. Is this when it was enacted? 2009-07-21: 100_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/reduction_rate.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/reduction_rate.yaml index 2904ab404..7bf748753 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/reduction_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_allowance/reduction_rate.yaml @@ -1,4 +1,4 @@ -description: Reduction rate for the Personal Allowance +description: Reduction rate for the Personal Allowance. values: 2009-07-21: 0.5 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/additional.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/additional.yaml index 09cb9124c..bc03520f9 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/additional.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/additional.yaml @@ -1,4 +1,4 @@ -description: Savings allowance in the additional threshold +description: Savings allowance in the additional threshold. values: 2005-04-01: value: 0 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/basic.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/basic.yaml index 1c01f7d8e..b974357dc 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/basic.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/basic.yaml @@ -1,4 +1,4 @@ -description: Savings allowance in the basic threshold +description: Savings allowance in the basic threshold. values: 2005-04-01: value: 1_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/higher.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/higher.yaml index 979b00faf..0f438df58 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/higher.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/personal_savings_allowance/higher.yaml @@ -1,4 +1,4 @@ -description: Savings allowance in the higher threshold +description: Savings allowance in the higher threshold. values: 2005-04-01: value: 500 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/property_allowance.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/property_allowance.yaml index 46cd04161..64170ed23 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/property_allowance.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/property_allowance.yaml @@ -1,4 +1,4 @@ -description: Amount of income from property untaxed per year +description: Amount of income from property untaxed per year. values: 2005-04-01: value: 1_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/trading_allowance.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/trading_allowance.yaml index ce7bd47df..5e84fde99 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/trading_allowance.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/allowances/trading_allowance.yaml @@ -1,4 +1,4 @@ -description: Amount of trading income untaxed per year +description: Amount of trading income untaxed per year. values: 2005-04-01: value: 1_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/bases/taxable_self_employment_income_deductions.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/bases/taxable_self_employment_income_deductions.yaml index 890e29b30..9b7c33a1d 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/bases/taxable_self_employment_income_deductions.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/bases/taxable_self_employment_income_deductions.yaml @@ -1,4 +1,4 @@ -description: Pre-tax deductions applied to self-employment income +description: Pre-tax deductions applied to self-employment income. values: 0000-01-01: - loss_relief diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_end.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_end.yaml index 8968eb2e2..bd9510aef 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_end.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_end.yaml @@ -1,4 +1,4 @@ -description: Income after which the Child Benefit is fully phased out +description: Income after which the Child Benefit is fully phased out. values: 2015-06-05: 60_000 2024-01-01: 80_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_start.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_start.yaml index 72ba18ae3..2114c5db9 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_start.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/charges/CB_HITC/phase_out_start.yaml @@ -1,4 +1,4 @@ -description: Income after which the Child Benefit phases out +description: Income after which the Child Benefit phases out. values: 2015-06-05: 50_000 2024-01-01: 60_000 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/earned_taxable_income_exclusions.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/earned_taxable_income_exclusions.yaml index ccdb92fa9..d40254f49 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/earned_taxable_income_exclusions.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/earned_taxable_income_exclusions.yaml @@ -1,4 +1,4 @@ -description: Exclusions to earned taxable income +description: Exclusions to earned taxable income. values: 0000-01-01: - taxable_savings_interest_income diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_additions.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_additions.yaml index ac1bb06d1..df5f016a9 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_additions.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_additions.yaml @@ -1,4 +1,4 @@ -description: All variables that are added together to calculate total income tax +description: All variables that are added together to calculate total income tax. metadata: label: Additive components of total Income Tax unit: list diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_subtractions.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_subtractions.yaml index 2ef30247f..b516d33e3 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_subtractions.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/income_tax_subtractions.yaml @@ -1,4 +1,4 @@ -description: All variables that are subtracted from the base amount to calculate total income tax +description: All variables that are subtracted from the base amount to calculate total income tax. metadata: label: Subtractive components of total Income Tax unit: list diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/allowance.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/allowance.yaml index af026df2f..bb57a2824 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/allowance.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/allowance.yaml @@ -1,4 +1,4 @@ -description: Starter allowance for savings +description: Starter allowance for savings. values: 2010-04-01: 5_000 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/phase_out.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/phase_out.yaml index c6b06e91d..99f4bb8e3 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/phase_out.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/savings_starter_rate/phase_out.yaml @@ -1,4 +1,4 @@ -description: Starter Rate for Savings phase-out rate +description: Starter Rate for Savings phase-out rate. values: 2014-04-06: 1 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/scotland/rates.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/scotland/rates.yaml index 43535cf3a..97795115c 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/scotland/rates.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/scotland/rates.yaml @@ -1,4 +1,4 @@ -description: Rates for Scottish Income Tax +description: Rates for Scottish Income Tax. brackets: - threshold: values: diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/uk.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/uk.yaml index 84e086654..dba54d160 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/rates/uk.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/rates/uk.yaml @@ -103,7 +103,7 @@ brackets: unit: currency-GBP values: 2015-04-05: 10_000_000 -description: Income Tax scale +description: Income Tax scale. metadata: label: Income Tax main rates rate_unit: /1 diff --git a/policyengine_uk/parameters/gov/hmrc/income_tax/reliefs/pension_contribution/basic_amount.yaml b/policyengine_uk/parameters/gov/hmrc/income_tax/reliefs/pension_contribution/basic_amount.yaml index cfa909d07..378444f3a 100644 --- a/policyengine_uk/parameters/gov/hmrc/income_tax/reliefs/pension_contribution/basic_amount.yaml +++ b/policyengine_uk/parameters/gov/hmrc/income_tax/reliefs/pension_contribution/basic_amount.yaml @@ -1,4 +1,4 @@ -description: The 'basic amount' - the maximum amount of tax relief from pension contributions +description: The 'basic amount' - the maximum amount of tax relief from pension contributions. metadata: economy: false propagate_metadata_to_children: true diff --git a/policyengine_uk/parameters/gov/hmrc/minimum_wage/apprentice.yaml b/policyengine_uk/parameters/gov/hmrc/minimum_wage/apprentice.yaml index 58690d008..9d0c9a8a5 100644 --- a/policyengine_uk/parameters/gov/hmrc/minimum_wage/apprentice.yaml +++ b/policyengine_uk/parameters/gov/hmrc/minimum_wage/apprentice.yaml @@ -1,4 +1,4 @@ -description: Minimum wage rate for apprentices +description: Minimum wage rate for apprentices. values: 2012-10-01: 2.65 2013-10-01: 2.68 diff --git a/policyengine_uk/parameters/gov/hmrc/minimum_wage/non_apprentice.yaml b/policyengine_uk/parameters/gov/hmrc/minimum_wage/non_apprentice.yaml index 6cae33ebd..84a0c108b 100644 --- a/policyengine_uk/parameters/gov/hmrc/minimum_wage/non_apprentice.yaml +++ b/policyengine_uk/parameters/gov/hmrc/minimum_wage/non_apprentice.yaml @@ -1,4 +1,4 @@ -description: Minimum wage rate for non-apprentices by age +description: Minimum wage rate for non-apprentices by age. brackets: - threshold: diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/additional.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/additional.yaml index 31a0e427f..717968b8a 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/additional.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/additional.yaml @@ -1,4 +1,4 @@ -description: The Class 1 National Insurance additional rate is paid on employment earnings above the Upper Earnings Limit +description: The Class 1 National Insurance additional rate is paid on employment earnings above the Upper Earnings Limit. values: 2015-04-01: 0.02 2022-04-01: diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/main.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/main.yaml index 5967eb5aa..4a2474d2d 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/main.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employee/main.yaml @@ -1,4 +1,4 @@ -description: The Class 1 National Insurance main rate is paid on employment earnings between the Primary Threshold and the Upper Earnings Limit +description: The Class 1 National Insurance main rate is paid on employment earnings between the Primary Threshold and the Upper Earnings Limit. values: 2015-04-01: 0.12 2022-04-01: diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employer.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employer.yaml index a25b0810a..b5b8f95aa 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employer.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/rates/employer.yaml @@ -1,5 +1,5 @@ description: National Insurance contribution rate by employers on earnings above the - Secondary Threshold + Secondary Threshold. metadata: label: NI employer rate propagate_metadata_to_children: true diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/lower_earnings_limit.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/lower_earnings_limit.yaml index 9e85e5ca8..3800967c4 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/lower_earnings_limit.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/lower_earnings_limit.yaml @@ -1,4 +1,4 @@ -description: Lower earnings limit for National Insurance +description: Lower earnings limit for National Insurance. metadata: economy: false period: week diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/primary_threshold.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/primary_threshold.yaml index 94b9be35a..6f6ce4b96 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/primary_threshold.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/primary_threshold.yaml @@ -1,4 +1,4 @@ -description: The Primary Threshold is the lower bound for the main rate of Class 1 National Insurance +description: The Primary Threshold is the lower bound for the main rate of Class 1 National Insurance. values: 2015-04-06: 155 2016-04-06: 155 diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/secondary_threshold.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/secondary_threshold.yaml index 481e1d6ab..0d29c4dcb 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/secondary_threshold.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/secondary_threshold.yaml @@ -1,4 +1,4 @@ -description: Secondary threshold for National Insurance +description: Secondary threshold for National Insurance. metadata: label: NI secondary threshold period: week diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/upper_earnings_limit.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/upper_earnings_limit.yaml index e1b02e051..370eceff7 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/upper_earnings_limit.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_1/thresholds/upper_earnings_limit.yaml @@ -1,4 +1,4 @@ -description: The Upper Earnings Limit is the upper bound for the main rate of Class 1 National Insurance +description: The Upper Earnings Limit is the upper bound for the main rate of Class 1 National Insurance. values: 2015-04-06: 815 2016-04-06: 827 diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/flat_rate.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/flat_rate.yaml index da8dd1e37..ff3774848 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/flat_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/flat_rate.yaml @@ -1,4 +1,4 @@ -description: Flat rate National Insurance contribution for self-employed earners +description: Flat rate National Insurance contribution for self-employed earners. values: 2015-04-01: 2.8 2017-04-01: 2.85 diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/small_profits_threshold.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/small_profits_threshold.yaml index 0fc7c882a..a8c5eb747 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/small_profits_threshold.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_2/small_profits_threshold.yaml @@ -1,4 +1,4 @@ -description: Small profits National Insurance threshold for self-employed earners +description: Small profits National Insurance threshold for self-employed earners. values: 2015-04-06: 3_965 2017-04-06: 6_025 diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/additional.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/additional.yaml index 50bfadb7c..5326d9ae3 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/additional.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/additional.yaml @@ -1,4 +1,4 @@ -description: The additional National Insurance rate paid above the Upper Profits Limit for self-employed profits +description: The additional National Insurance rate paid above the Upper Profits Limit for self-employed profits. values: 2015-04-01: 0.02 2022-04-01: diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/main.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/main.yaml index 7eb5c6bcb..1ef51cea6 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/main.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/rates/main.yaml @@ -1,4 +1,4 @@ -description: The main National Insurance rate paid between the Lower and Upper Profits Limits for self-employed profits +description: The main National Insurance rate paid between the Lower and Upper Profits Limits for self-employed profits. values: 2015-04-01: 0.09 2022-04-01: diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/lower_profits_limit.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/lower_profits_limit.yaml index efc979d96..504c1a5fe 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/lower_profits_limit.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/lower_profits_limit.yaml @@ -1,4 +1,4 @@ -description: The Lower Profits Limit is the threshold at which self-employed earners pay the main Class 4 National Insurance rate +description: The Lower Profits Limit is the threshold at which self-employed earners pay the main Class 4 National Insurance rate. values: 2015-04-06: 8_060 2017-04-06: 8_164 diff --git a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/upper_profits_limit.yaml b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/upper_profits_limit.yaml index 62e5531d4..7182b8ebe 100644 --- a/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/upper_profits_limit.yaml +++ b/policyengine_uk/parameters/gov/hmrc/national_insurance/class_4/thresholds/upper_profits_limit.yaml @@ -1,4 +1,4 @@ -description: The Upper Profits Limit is the threshold at which self-employed earners pay the additional Class 4 National Insurance rate +description: The Upper Profits Limit is the threshold at which self-employed earners pay the additional Class 4 National Insurance rate. values: 2015-04-06: 42_386 2015-06-05: 43_000 diff --git a/policyengine_uk/parameters/gov/hmrc/pensions/pensions_programs.yaml b/policyengine_uk/parameters/gov/hmrc/pensions/pensions_programs.yaml index 694ad69c3..15cfafccf 100644 --- a/policyengine_uk/parameters/gov/hmrc/pensions/pensions_programs.yaml +++ b/policyengine_uk/parameters/gov/hmrc/pensions/pensions_programs.yaml @@ -1,4 +1,4 @@ -description: Pensions programs +description: Pensions programs. values: 0000-01-01: - personal_pension_contributions diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/purchase.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/purchase.yaml index 8955744ed..3f73561c6 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/purchase.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/purchase.yaml @@ -19,7 +19,7 @@ brackets: threshold: 2003-07-10: 500000 2016-09-15: null -description: Stamp Duty Land Tax progressive rates for non-residential property transfers +description: Stamp Duty Land Tax progressive rates for non-residential property transfers. metadata: economy: false label: Stamp Duty on non-residential property diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/rent.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/rent.yaml index 2299a37d5..713999082 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/rent.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/non_residential/rent.yaml @@ -12,7 +12,7 @@ brackets: threshold: 2016-09-15: 5000000 description: Stamp Duty Land Tax progressive rates for cumulative rents on non-residential - property + property. metadata: economy: false label: Stamp Duty on non-residential cumulative rent diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/min.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/min.yaml index 6d35003e3..2640c724b 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/min.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/min.yaml @@ -1,4 +1,4 @@ -description: Minimum value for taxability of additional residential property +description: Minimum value for taxability of additional residential property. values: 2016-09-15: 40_000 metadata: diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/rate.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/rate.yaml index bda027061..e07522ab1 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/additional/rate.yaml @@ -1,4 +1,4 @@ -description: Stamp Duty Land Tax progressive rates for residential property transfers that are not replacements of an individual's primary residence +description: Stamp Duty Land Tax progressive rates for residential property transfers that are not replacements of an individual's primary residence. brackets: - rate: 2016-09-15: 0.03 diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/first/rate.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/first/rate.yaml index b021c7c8c..920d1788c 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/first/rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/first/rate.yaml @@ -7,7 +7,7 @@ brackets: 2018-03-15: 0.05 threshold: 2018-03-15: 300000 -description: Stamp Duty Land Tax progressive rates for residential property transfers +description: Stamp Duty Land Tax progressive rates for residential property transfers. metadata: economy: false label: Stamp Duty on first homes diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/subsequent.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/subsequent.yaml index 696e555b5..8b790e52a 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/subsequent.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/purchase/main/subsequent.yaml @@ -39,7 +39,7 @@ brackets: threshold: 2012-07-17: 2000000 2015-02-12: null -description: Stamp Duty Land Tax progressive rates for residential property transfers +description: Stamp Duty Land Tax progressive rates for residential property transfers. metadata: economy: false label: Stamp Duty on non-first primary homes diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/rent.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/rent.yaml index ff5863e09..e89a8083c 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/rent.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/residential/rent.yaml @@ -12,7 +12,7 @@ brackets: 2020-07-08: 500000 2021-03-31: 125000 description: Stamp Duty Land Tax progressive rates for cumulative rents on residential - property + property. metadata: economy: false label: Stamp Duty on cumulative rent diff --git a/policyengine_uk/parameters/gov/hmrc/stamp_duty/statistics.yaml b/policyengine_uk/parameters/gov/hmrc/stamp_duty/statistics.yaml index 72c29fb5e..c138e6c4e 100644 --- a/policyengine_uk/parameters/gov/hmrc/stamp_duty/statistics.yaml +++ b/policyengine_uk/parameters/gov/hmrc/stamp_duty/statistics.yaml @@ -1,4 +1,4 @@ -description: Stamp Duty Land Tax statistics +description: Stamp Duty Land Tax statistics. metadata: economy: false propagate_metadata_to_children: true diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/index.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/index.yaml index 2aa993fe4..0d122a1e7 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/index.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/index.yaml @@ -1,4 +1,4 @@ -description: Student loan interest rates +description: Student loan interest rates. label: Interest rates documentation: | Interest rates applied to student loan balances vary by plan type. diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_1/boe_margin.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_1/boe_margin.yaml index e3576a31c..cfb030ff8 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_1/boe_margin.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_1/boe_margin.yaml @@ -1,4 +1,4 @@ -description: Plan 1 margin added to Bank of England base rate for interest calculation +description: Plan 1 margin added to Bank of England base rate for interest calculation. metadata: label: Plan 1 BoE margin unit: /1 diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/additional_rate.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/additional_rate.yaml index 7c46b0d83..af47a62d3 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/additional_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/additional_rate.yaml @@ -1,4 +1,4 @@ -description: Plan 2 maximum additional interest rate +description: Plan 2 maximum additional interest rate. metadata: label: Plan 2 additional rate unit: /1 diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/index.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/index.yaml index 6792c5306..0ff4c1ab6 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/index.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/index.yaml @@ -1,4 +1,4 @@ -description: Plan 2 student loan interest rates +description: Plan 2 student loan interest rates. label: Plan 2 interest rates documentation: | Plan 2 student loan interest rates are income-contingent after graduation. diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/upper_threshold.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/upper_threshold.yaml index edf016d70..5ace64efb 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/upper_threshold.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/plan_2/upper_threshold.yaml @@ -1,4 +1,4 @@ -description: Plan 2 upper income threshold for interest rate tapering +description: Plan 2 upper income threshold for interest rate tapering. metadata: label: Plan 2 interest upper threshold unit: currency-GBP diff --git a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/postgraduate_additional_rate.yaml b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/postgraduate_additional_rate.yaml index 20a04d4e7..4d90d7763 100644 --- a/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/postgraduate_additional_rate.yaml +++ b/policyengine_uk/parameters/gov/hmrc/student_loans/interest_rates/postgraduate_additional_rate.yaml @@ -1,4 +1,4 @@ -description: Additional interest rate above RPI for Postgraduate loans +description: Additional interest rate above RPI for Postgraduate loans. metadata: label: Postgraduate additional rate unit: /1 diff --git a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/non_residential.yaml b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/non_residential.yaml index 59702ccfb..b0bb1d83a 100644 --- a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/non_residential.yaml +++ b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/non_residential.yaml @@ -14,7 +14,7 @@ brackets: threshold: 2015-04-01: 350000 2019-01-25: 250000 -description: Rates on Scotland's non-residential property purchases +description: Rates on Scotland's non-residential property purchases. metadata: economy: false label: Lbtt on non-residential property diff --git a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/rent.yaml b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/rent.yaml index 265390830..8ca38d941 100644 --- a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/rent.yaml +++ b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/rent.yaml @@ -11,7 +11,7 @@ brackets: 2019-01-25: 0.05 threshold: 2019-01-25: 2000000 -description: Rates on cumulative rent +description: Rates on cumulative rent. metadata: economy: false label: Lbtt on cumulative rent diff --git a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/residential/rate.yaml b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/residential/rate.yaml index 23b684b35..531c25c68 100644 --- a/policyengine_uk/parameters/gov/revenue_scotland/lbtt/residential/rate.yaml +++ b/policyengine_uk/parameters/gov/revenue_scotland/lbtt/residential/rate.yaml @@ -23,7 +23,7 @@ brackets: 2015-04-01: 0.12 threshold: 2015-04-01: 750000 -description: Rates on Scotland's residential property purchases +description: Rates on Scotland's residential property purchases. metadata: economy: false label: Lbtt on residential property diff --git a/policyengine_uk/parameters/gov/simulation/microdata_vat_coverage.yaml b/policyengine_uk/parameters/gov/simulation/microdata_vat_coverage.yaml index 601aa9417..f82936e09 100644 --- a/policyengine_uk/parameters/gov/simulation/microdata_vat_coverage.yaml +++ b/policyengine_uk/parameters/gov/simulation/microdata_vat_coverage.yaml @@ -1,4 +1,4 @@ -description: LCFS (from which ETB data is derived) microdata is known to under-report household consumption. We scale up the VAT liability to hit HMRC-reported VAT receipts (following the approach of IFS' TAXBEN, though they might have better coverage anyway from access to the non-EUL dataset). For HMRC statistics see https://www.gov.uk/government/statistics/value-added-tax-vat-annual-statistics +description: LCFS (from which ETB data is derived) microdata is known to under-report household consumption. We scale up the VAT liability to hit HMRC-reported VAT receipts (following the approach of IFS' TAXBEN, though they might have better coverage anyway from access to the non-EUL dataset). For HMRC statistics see https://www.gov.uk/government/statistics/value-added-tax-vat-annual-statistics. metadata: unit: /1 period: year diff --git a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_factor.yaml b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_factor.yaml index 9c0cb5f8b..df253e3b2 100644 --- a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_factor.yaml +++ b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_factor.yaml @@ -1,4 +1,4 @@ -description: student polulation adjustment factor, tested by Vahid +description: student polulation adjustment factor, tested by Vahid. values: 2010-01-01: 0.85 metadata: diff --git a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_fees.yaml b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_fees.yaml index e394f33ee..012579ec0 100644 --- a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_fees.yaml +++ b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_fees.yaml @@ -1,4 +1,4 @@ -description: Mean annual private school fee +description: Mean annual private school fee. values: 2022-01-01: 15_200 metadata: diff --git a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_vat_basis.yaml b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_vat_basis.yaml index 0ee5e0540..523a3b989 100644 --- a/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_vat_basis.yaml +++ b/policyengine_uk/parameters/gov/simulation/private_school_vat/private_school_vat_basis.yaml @@ -1,4 +1,4 @@ -description: Effective percentage of private school tuition subject to VAT +description: Effective percentage of private school tuition subject to VAT. # Per IFS article # (https://ifs.org.uk/publications/tax-private-school-fees-and-state-school-spending), # about 25% of private school costs would be diff --git a/policyengine_uk/parameters/gov/wra/land_transaction_tax/non_residential.yaml b/policyengine_uk/parameters/gov/wra/land_transaction_tax/non_residential.yaml index 075762154..1baa9bb43 100644 --- a/policyengine_uk/parameters/gov/wra/land_transaction_tax/non_residential.yaml +++ b/policyengine_uk/parameters/gov/wra/land_transaction_tax/non_residential.yaml @@ -16,7 +16,7 @@ brackets: 2018-04-01: 0.06 threshold: 2018-04-01: 1000000 -description: Non-residential property progressive tax scale +description: Non-residential property progressive tax scale. metadata: economy: false label: Ltt on non-residential property diff --git a/policyengine_uk/parameters/gov/wra/land_transaction_tax/rent.yaml b/policyengine_uk/parameters/gov/wra/land_transaction_tax/rent.yaml index a877f0f0d..1f904567f 100644 --- a/policyengine_uk/parameters/gov/wra/land_transaction_tax/rent.yaml +++ b/policyengine_uk/parameters/gov/wra/land_transaction_tax/rent.yaml @@ -12,7 +12,7 @@ brackets: 2018-04-01: 0.02 threshold: 2018-04-01: 2000000 -description: Progressive tax scale for cumulative rent +description: Progressive tax scale for cumulative rent. metadata: economy: false label: Ltt on cumulative rent diff --git a/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/higher_rate.yaml b/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/higher_rate.yaml index 3a67d2962..3729a9557 100644 --- a/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/higher_rate.yaml +++ b/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/higher_rate.yaml @@ -29,7 +29,7 @@ brackets: 2020-12-22: 0.16 threshold: 2018-04-01: 1500000 -description: Higher residential property progressive tax scale for non-primary residences +description: Higher residential property progressive tax scale for non-primary residences. metadata: economy: false label: Ltt on secondary residences diff --git a/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/primary.yaml b/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/primary.yaml index af3f94c35..627eb0fb8 100644 --- a/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/primary.yaml +++ b/policyengine_uk/parameters/gov/wra/land_transaction_tax/residential/primary.yaml @@ -27,7 +27,7 @@ brackets: 2018-04-01: 0.12 threshold: 2018-04-01: 1500000 -description: Residential property progressive tax scale for primary residences +description: Residential property progressive tax scale for primary residences. metadata: economy: false label: Ltt on primary residences diff --git a/policyengine_uk/parameters/household/consumption/carbon/consumption.yaml b/policyengine_uk/parameters/household/consumption/carbon/consumption.yaml index 127888c5a..2469b839b 100644 --- a/policyengine_uk/parameters/household/consumption/carbon/consumption.yaml +++ b/policyengine_uk/parameters/household/consumption/carbon/consumption.yaml @@ -1,4 +1,4 @@ -description: Carbon emissions, household based consumption +description: Carbon emissions, household based consumption. values: 2016-01-01: 570_480_000 2017-01-01: 543_520_000 diff --git a/policyengine_uk/parameters/household/consumption/carbon/emissions.yaml b/policyengine_uk/parameters/household/consumption/carbon/emissions.yaml index b7c3b42de..76c787032 100644 --- a/policyengine_uk/parameters/household/consumption/carbon/emissions.yaml +++ b/policyengine_uk/parameters/household/consumption/carbon/emissions.yaml @@ -1,4 +1,4 @@ -description: Total CO2 emissions by sector +description: Total CO2 emissions by sector. reference: - title: UK's carbon footprint - Official Statistics href: https://www.gov.uk/government/statistics/uks-carbon-footprint diff --git a/policyengine_uk/parameters/household/consumption/carbon/production.yaml b/policyengine_uk/parameters/household/consumption/carbon/production.yaml index 56de05cf2..c62e9e089 100644 --- a/policyengine_uk/parameters/household/consumption/carbon/production.yaml +++ b/policyengine_uk/parameters/household/consumption/carbon/production.yaml @@ -1,4 +1,4 @@ -description: Carbon emissions from the production of goods and services in the UK +description: Carbon emissions from the production of goods and services in the UK. values: 2016-01-01: 481_000_000 2017-01-01: 469_000_000 diff --git a/policyengine_uk/parameters/household/demographic/equiv/ahc/child_over_14.yaml b/policyengine_uk/parameters/household/demographic/equiv/ahc/child_over_14.yaml index dfa79868e..1d6ffa7ed 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/ahc/child_over_14.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/ahc/child_over_14.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for children over 14 +description: Equivalisation factor for children over 14. values: 2010-04-01: 0.42 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/ahc/child_under_14.yaml b/policyengine_uk/parameters/household/demographic/equiv/ahc/child_under_14.yaml index bb5cb59e7..da01424b6 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/ahc/child_under_14.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/ahc/child_under_14.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for children under 14 +description: Equivalisation factor for children under 14. values: 2010-04-01: 0.2 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/ahc/first_adult.yaml b/policyengine_uk/parameters/household/demographic/equiv/ahc/first_adult.yaml index 0361ddf59..ee99a80f6 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/ahc/first_adult.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/ahc/first_adult.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for the first adult +description: Equivalisation factor for the first adult. values: 2010-04-01: 0.58 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/ahc/second_adult.yaml b/policyengine_uk/parameters/household/demographic/equiv/ahc/second_adult.yaml index cba06675e..ef7659e18 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/ahc/second_adult.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/ahc/second_adult.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for the second adult +description: Equivalisation factor for the second adult. values: 2010-04-01: 0.42 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/bhc/child_over_14.yaml b/policyengine_uk/parameters/household/demographic/equiv/bhc/child_over_14.yaml index 4ddb773f4..bd2bdcb8b 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/bhc/child_over_14.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/bhc/child_over_14.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for children over 14 +description: Equivalisation factor for children over 14. values: 2010-04-01: 0.33 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/bhc/child_under_14.yaml b/policyengine_uk/parameters/household/demographic/equiv/bhc/child_under_14.yaml index bb5cb59e7..da01424b6 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/bhc/child_under_14.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/bhc/child_under_14.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for children under 14 +description: Equivalisation factor for children under 14. values: 2010-04-01: 0.2 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/bhc/first_adult.yaml b/policyengine_uk/parameters/household/demographic/equiv/bhc/first_adult.yaml index ed6795e0b..c23532851 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/bhc/first_adult.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/bhc/first_adult.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for the first adult +description: Equivalisation factor for the first adult. values: 2010-04-01: 0.67 metadata: diff --git a/policyengine_uk/parameters/household/demographic/equiv/bhc/second_adult.yaml b/policyengine_uk/parameters/household/demographic/equiv/bhc/second_adult.yaml index f811e725c..9284223d5 100644 --- a/policyengine_uk/parameters/household/demographic/equiv/bhc/second_adult.yaml +++ b/policyengine_uk/parameters/household/demographic/equiv/bhc/second_adult.yaml @@ -1,4 +1,4 @@ -description: Equivalisation factor for the second adult +description: Equivalisation factor for the second adult. values: 2010-04-01: 0.33 metadata: diff --git a/policyengine_uk/parameters/household/poverty/absolute_poverty_threshold_bhc.yaml b/policyengine_uk/parameters/household/poverty/absolute_poverty_threshold_bhc.yaml index bcce76738..b20a7fa73 100644 --- a/policyengine_uk/parameters/household/poverty/absolute_poverty_threshold_bhc.yaml +++ b/policyengine_uk/parameters/household/poverty/absolute_poverty_threshold_bhc.yaml @@ -1,4 +1,4 @@ -description: Absolute poverty threshold for equivalised household net income, before housing costs +description: Absolute poverty threshold for equivalised household net income, before housing costs. values: 2010-01-01: 251.4 2020-01-01: 305.7 diff --git a/policyengine_uk/parameters/household/poverty/exclude_non_hbai_income.yaml b/policyengine_uk/parameters/household/poverty/exclude_non_hbai_income.yaml index 265887c43..0f9ad586c 100644 --- a/policyengine_uk/parameters/household/poverty/exclude_non_hbai_income.yaml +++ b/policyengine_uk/parameters/household/poverty/exclude_non_hbai_income.yaml @@ -1,4 +1,4 @@ -description: Whether to exclude non-HBAI income from poverty calculations +description: Whether to exclude non-HBAI income from poverty calculations. values: 2010-01-01: true metadata: diff --git a/policyengine_uk/parameters/household/wealth/land/intensity.yaml b/policyengine_uk/parameters/household/wealth/land/intensity.yaml index fe1c79ff3..77a5aba6a 100644 --- a/policyengine_uk/parameters/household/wealth/land/intensity.yaml +++ b/policyengine_uk/parameters/household/wealth/land/intensity.yaml @@ -1,4 +1,4 @@ -description: Land intensity by asset type (where microsimulation data is not available) +description: Land intensity by asset type (where microsimulation data is not available). metadata: unit: /1 corporate_wealth: diff --git a/policyengine_uk/parameters/household/wealth/national_balance_sheet.yaml b/policyengine_uk/parameters/household/wealth/national_balance_sheet.yaml index 29060628d..24dceb5dc 100644 --- a/policyengine_uk/parameters/household/wealth/national_balance_sheet.yaml +++ b/policyengine_uk/parameters/household/wealth/national_balance_sheet.yaml @@ -1,4 +1,4 @@ -description: ONS National Balance Sheet statistics on wealth +description: ONS National Balance Sheet statistics on wealth. household: metadata: uprating: gov.economic_assumptions.indices.obr.per_capita.gdp diff --git a/policyengine_uk/tests/test_parameter_descriptions.py b/policyengine_uk/tests/test_parameter_descriptions.py new file mode 100644 index 000000000..9d4503098 --- /dev/null +++ b/policyengine_uk/tests/test_parameter_descriptions.py @@ -0,0 +1,45 @@ +"""Structural tests for parameter metadata.""" + +from pathlib import Path + +import yaml + +PARAMETERS_ROOT = Path(__file__).resolve().parent.parent / "parameters" + + +def _yaml_files(): + return sorted(PARAMETERS_ROOT.rglob("*.yaml")) + + +def _parameter_files_with_descriptions(): + files = [] + for path in _yaml_files(): + if "tests" in path.parts: + continue + try: + data = yaml.safe_load(path.read_text()) + except Exception: + # A handful of parameter files use date-like keys that pyyaml + # treats as out-of-range datetimes when scanning generically; + # skip rather than crash, the substantive descriptions live in + # files we can parse. + continue + if not isinstance(data, dict): + continue + description = data.get("description") + if isinstance(description, str) and description.strip(): + files.append((path, description.strip())) + return files + + +def test_parameter_descriptions_end_with_period(): + """Every parameter description must end with a period — see #340.""" + offenders = [ + path.relative_to(PARAMETERS_ROOT) + for path, description in _parameter_files_with_descriptions() + if not description.endswith(".") + ] + assert not offenders, ( + "Parameter descriptions should end with a period for consistency. " + f"{len(offenders)} file(s) do not:\n" + "\n".join(f" - {p}" for p in offenders) + )