Improve docs #318
Merged
Improve docs #318
Conversation
This file contains 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
In general: - improve function and variable naming - reformat docstrings - remove unneccesary docstring text Add_citation_to_sentence - simplify - stop adding citations after adding success (cited = True) - do not calculate similarity comparisons unless they're needed - return immediately for short sentences Add a bit more detail to tests, and some TODO tests
Improve docstrings `poetry run make format` Replace a print() statement with logger.debug()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Your checklist for this pull request
Thank you for submitting a pull request! To speed up the review process, please follow this checklist:
make format)/docs)pytest tests(offline mode)Additional steps for code with networking dependencies:
pytest tests --external_api(online mode, making network calls)Description
Improve docstrings
poetry run make formatReplace a print() statement with logger.debug()
This code is based on #317. Please review and merge that PR first.