Document all functions in ocr/ and add relevant type signatures
#512
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
jonchang
force-pushed
the
docstrings-ocr
branch
3 times, most recently
from
ec548c2 to
721c1a5
Compare
jonchang
force-pushed
the
docstrings-ocr
branch
from
90b2299 to
fdfe563
Compare
knguyenrise8
approved these changes
Jan 16, 2025
arinkulshi-skylight
approved these changes
Jan 16, 2025
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.
Description
Also, add lint checks to ensure that Google-style docstrings are enforced. There are a few exclusions, namely for test and test-related files, and the phdc_converter subdirectory which seems to not be used and is already documented in a different style.
Related Issues
#504
Checklist