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 the comparisons configuration section #159

Merged
merged 10 commits into from
Nov 1, 2024
Merged

Improve documentation for the comparisons configuration section #159

merged 10 commits into from
Nov 1, 2024

Conversation

riley-harper
Copy link
Contributor

@riley-harper riley-harper commented Nov 1, 2024 •
edited
Loading

Previously, the docs heavily implied that comparisons worked the same way as comparison_features, which is not true. I've done some research on how comparisons actually work, added some unit tests for functions in linking.core.comparison, and updated the documentation.

Here are the main things that this PR accomplishes:

  • Added type hints and unit tests for linking.core.comparison's get_comparison_leaves() and generate_comparison().
  • Added more detail to the Comparisons section on the Configuration documentation page and corrected misleading information.
  • Created a new Comparisons page in the documentation.
  • Renamed the Comparison Types documentation page to Comparison Features and made the introduction more helpful.
  • Upgraded Sphinx to the newest version, 8.1.3. Removed old files from the docs/ directory and re-ran Sphinx to regenerate what it needs now.
  • Fixed two minor Sphinx build warnings.

@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
[#158] Add type hints to core.comparison.get_comparison_leaves()
4023733
@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
[#158] Add type hints and tweak documentation for core.comparison.gen…
c855921 
…erate_comparison()
@riley-harper
[#158] Add a rough draft of a comparisons documentation page
0e3c85e
@riley-harper
[#158] Edit the configuration section on comparisons
a3f8b48
@riley-harper
[#158] Update the documentation for household comparisons
319c60b
@riley-harper
[#158] Rename the "Comparison Types" page to "Comparison Features"
63a49d8
@riley-harper
[#158] Update sphinx to 8.1.3 and regenerate the docs
6f7004d
@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 riley-harper merged commit d89a6da into main Nov 1, 2024
6 checks passed
@riley-harper riley-harper deleted the comparison_core_tests_and_docs branch November 1, 2024 15:39
@riley-harper riley-harper mentioned this pull request Dec 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@riley-harper