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

Improve documentation for hlink.linking.core.comparison #158

Closed
riley-harper opened this issue Oct 29, 2024 · 1 comment
Closed

Improve documentation for hlink.linking.core.comparison #158

riley-harper opened this issue Oct 29, 2024 · 1 comment
Labels
component: core documentation Improvements or additions to documentation

Comments

@riley-harper
Copy link
Contributor

If you read through the docs, you might get the strong impression that the comparison section is closely related to comparison_features, and that it essentially works in the same way. I used to think this was true, but looking at the comparison.py module more closely, there is actually a lot of unique logic in there that is unrelated to comparison features. We should clarify how all of this works in the docs and also possibly add some unit tests as examples of how the code works.
@riley-harper riley-harper added the documentation Improvements or additions to documentation label Oct 29, 2024
riley-harper added a commit that referenced this issue Oct 29, 2024
@riley-harper
[#158] Add some unit tests for core.comparison.get_comparison_leaves()
4619d63 
The logic in this function that deals with the secondary, threshold_a, and
threshold_b attributes isn't tested or documented, and I'm not sure exactly
what it's supposed to do.
riley-harper added a commit that referenced this issue Oct 29, 2024
@riley-harper
[#158] Add type hints to core.comparison.get_comparison_leaves()
4023733
riley-harper added a commit that referenced this issue Oct 29, 2024
@riley-harper
[#158] Add some unit tests for core.comparison.generate_comparison()
0fd0552 
This function is pretty well tested by the existing tests. There are a good
number of edge cases and errors that are not tested. It might be a good idea to
add additional unit tests for those.
riley-harper added a commit that referenced this issue Oct 29, 2024
@riley-harper
[#158] Add type hints and tweak documentation for core.comparison.gen…
c855921 
…erate_comparison()
riley-harper added a commit that referenced this issue Oct 29, 2024
@riley-harper
[#158] Add a rough draft of a comparisons documentation page
0e3c85e
riley-harper added a commit that referenced this issue Oct 30, 2024
@riley-harper
[#158] Edit the configuration section on comparisons
a3f8b48
riley-harper added a commit that referenced this issue Oct 30, 2024
@riley-harper
[#158] Update the documentation for household comparisons
319c60b
riley-harper added a commit that referenced this issue Oct 30, 2024
@riley-harper
[#158] Rename the "Comparison Types" page to "Comparison Features"
63a49d8
riley-harper added a commit that referenced this issue Nov 1, 2024
@riley-harper
[#158] Update sphinx to 8.1.3 and regenerate the docs
6f7004d
riley-harper added a commit that referenced this issue Nov 1, 2024
@riley-harper
[#158] Fix two Sphinx build warnings
f69e639 
- txt is not a Pygment lexer name. We should use text to indicate no highlighting instead of txt.
- There's no _static directory with static assets, so I removed that from conf.py.
@riley-harper
Copy link
Contributor Author

This was completed in #159.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: core documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@riley-harper