Open gzark1 opened 1 year ago
I am going to take up the task. I will follow the PEP 257 style guide and provide clear explanations, parameters, return values, and usage examples where applicable. I will create a new branch, make the necessary changes, and submit a pull request for review.
Description:
The code currently lacks proper documentation, making it difficult for users to understand the classes and methods and their intended usage. In order to improve the code's usability and maintainability, we should add comprehensive documentation.
Documentation Status:
Action Required:
Expected Documentation Style: We can use PEP 257 style docstrings for documenting classes, methods, and functions. Refer to the PEP 257 documentation for guidelines.
Specific Examples:
Endpoint
andWorks
have no documentation.do_http_request
in theHTTPRequest
class has no documentation