Skip to content
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

Jump to bottom

Documentation for substitution files is incorrect #163

Closed
riley-harper opened this issue Nov 20, 2024 · 0 comments · Fixed by #166
Closed

Documentation for substitution files is incorrect #163

riley-harper opened this issue Nov 20, 2024 · 0 comments · Fixed by #166
Labels
documentation Improvements or additions to documentation type: bug Something isn't working

Comments

@riley-harper
Copy link
Contributor

riley-harper commented Nov 20, 2024 •
edited
Loading

https://hlink.docs.ipums.org/substitutions.html says that

If the input column data equals a value in the first column of the substitution file, it is replaced with the data in the second column of the substitution file.

But this is backwards. Strings in the second column of the file are replaced with strings in the first column (at least as far as I can tell). We should double-check this and fix the documentation. This could be a good opportunity to improve the code documentation and add some unit tests as well.
@riley-harper riley-harper added type: bug Something isn't working documentation Improvements or additions to documentation labels Nov 20, 2024
riley-harper added a commit that referenced this issue Nov 25, 2024
@riley-harper
[#163] Add type hints to linking/core/substitutions.py
02d0856
riley-harper added a commit that referenced this issue Nov 25, 2024
@riley-harper
[#163] Add two unit tests for linking/core/substitutions.py
bf8b097 
These are a bit more straightforward and easier to find than the integration
tests in preprocessing_test.py.
riley-harper added a commit that referenced this issue Nov 25, 2024
@riley-harper
[#163] Correct the substitution file documentation
3c3c079 
We had the columns flipped around. Strings in the second column are replaced by
strings in the first column.
@riley-harper riley-harper mentioned this issue Nov 25, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation type: bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix a bug in the substitution file documentation ipums/hlink
1 participant
@riley-harper