Skip to content

Clarify current_education enrolment vs attainment (#368) #1733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vahid-ahmadi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify current_education enrolment vs attainment (#368) #1733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/368.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 6 additions & 1 deletion policyengine_uk/variables/household/demographic/current_education.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down