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

Fix a bug in the substitution file documentation #166

Merged
merged 3 commits into from
Nov 26, 2024
Merged

Fix a bug in the substitution file documentation #166

merged 3 commits into from
Nov 26, 2024

Conversation

riley-harper
Copy link
Contributor

Fixes #163.

This PR

  • Fixes a documentation bug in substitutions.md where we flip-flopped two columns. The substitution file has two columns. Strings in the second column are replaced by strings in the first column. But the documentation said the opposite and was wrong.
  • Adds type hints to hlink/linking/core/substitutions.py, which is the module with the substitution file logic.
  • Adds a couple of unit tests for hlink/linking/core/substitutions.py which make this behavior clear.

@riley-harper
[#163] Add type hints to linking/core/substitutions.py
02d0856
@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
[#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 requested a review from ccdavis November 25, 2024 22:49
@riley-harper riley-harper merged commit 72cda30 into main Nov 26, 2024
3 checks passed
@riley-harper riley-harper deleted the substitutions_fix branch November 26, 2024 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ccdavis ccdavis Awaiting requested review from ccdavis

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for substitution files is incorrect
1 participant
@riley-harper