Add comments and docstrings to main.py and api.py #49
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
This PR adds comments and docstrings to the main.py and api.py files in order to improve code readability and maintainability. The changes include adding a docstring at the beginning of each file to explain its purpose, adding comments above import statements to explain the purpose of each imported module, and adding comments to explain the functionality of specific variables and functions.
Summary of Changes
In main.py:
In api.py:
These changes improve the code's readability and make it easier for developers to understand the functionality of the code in main.py and api.py.
Fixes #11.
🎉 Latest improvements to Sweep:
💡 To get Sweep to edit this pull request, you can: