Minor readability changes #14
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
1. Added type annotations: I added type annotations to the function signatures to make the inputs and outputs more clear and easy to understand. This helps with code readability and makes it easier for other developers to use the functions. 2. Added docstrings to the functions: I added docstrings to describe the purpose of the functions, their parameters, and return values. This makes it easier for others to understand what the functions do and how to use them.
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.
Added type annotations: I added type annotations to the function signatures to make the inputs and outputs more clear and easy to understand. This helps with code readability and makes it easier for other developers to use the functions.
Added docstrings to the functions: I added docstrings to describe the purpose of the functions, their parameters, and return values. This makes it easier for others to understand what the functions do and how to use them.