Add code documentation for process()
#47
Open
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
add docstring and type annotations for `process()` function to describe what it does and how it works since this is the main function users will be interacting with.
add docstring and type annotations for `process()` function to describe what it does and how it works since this is the main function users will be interacting with. Update with examples in docstring.
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.
I added docstrings and type annotations for the
process()function to make it easier for users to figure out how exactly the package can be used to extract text and images.Although documentation is provided in the README.md file in the package's GitHub repository, I think it's important that the code itself is documented as well so that users don't have to visit the repository to figure out how to use the package, which is the situation I found myself in.
It'll also help IDEs do code completion for developers using the package.