Clarify current_education enrolment vs attainment (#368)#1733
Open
vahid-ahmadi wants to merge 1 commit into
Open
Clarify current_education enrolment vs attainment (#368)#1733vahid-ahmadi wants to merge 1 commit into
vahid-ahmadi wants to merge 1 commit into
Conversation
#368 suggested renaming current_education -> current_education_enrolment to distinguish enrolment from attainment. A full rename would break every dataset row, test YAML, API consumer (policyengine-app, household-api), and external user that passes current_education as input. Too disruptive for an issue whose actual ask is "make the enrolment-vs-attainment distinction explicit". Do the cheaper thing: improve the label to "Current education enrolment" and add a docstring that says it's enrolment status, not attainment, and points at highest_education for the latter. The variable name stays the same so no downstream breakage; the label is what users see in the API metadata and the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
current_educationtocurrent_education_enrolment#368 suggested renamingcurrent_educationtocurrent_education_enrolmentto distinguish enrolment from attainment.policyengine-app,policyengine-household-api), and external user that currently passescurrent_educationas input. That's too disruptive for an issue whose actual ask is "make the enrolment-vs-attainment distinction explicit."labelto\"Current education enrolment\"and add adocumentationstring that says it's enrolment status (not attainment) and points athighest_educationfor the latter.Test plan
Microsimulation()builds andsystem.variables[\"current_education\"].labelreturns the new label.🤖 Generated with Claude Code