diff --git a/changelog.d/368.md b/changelog.d/368.md new file mode 100644 index 000000000..a8b986d14 --- /dev/null +++ b/changelog.d/368.md @@ -0,0 +1 @@ +- Clarify the `current_education` label as "Current education enrolment" and add a docstring distinguishing it from `highest_education` (which captures attainment), so the variable's enrolment-vs-attainment semantics are explicit without an API-breaking rename. diff --git a/policyengine_uk/variables/household/demographic/current_education.py b/policyengine_uk/variables/household/demographic/current_education.py index e11d2846b..4cb464f50 100644 --- a/policyengine_uk/variables/household/demographic/current_education.py +++ b/policyengine_uk/variables/household/demographic/current_education.py @@ -10,7 +10,12 @@ class current_education(Variable): possible_values = EducationType default_value = EducationType.NOT_IN_EDUCATION entity = Person - label = "Current education" + label = "Current education enrolment" + documentation = ( + "Which stage of education the person is currently enrolled in (or " + "NOT_IN_EDUCATION if none). This is enrolment status, not attainment " + "— see `highest_education` for the highest completed stage." + ) definition_period = YEAR def formula(person, period, parameters):