Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Missing Documentation for Classes and Methods #58

Open
gzark1 opened this issue Jun 15, 2023 · 1 comment
Open

Add Missing Documentation for Classes and Methods #58

gzark1 opened this issue Jun 15, 2023 · 1 comment
Assignees

Comments

@gzark1
Copy link

gzark1 commented Jun 15, 2023

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:

  • Classes have no documentation
  • Some methods have documentation while others don't.
  • Lack of docstrings throughout the code.

Action Required:

  • Add docstrings to classes, methods, and functions where missing.
  • Improve or complete existing docstrings.
  • Ensure consistent style and formatting of the documentation.

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:

  • Class Endpoint and Works have no documentation.
  • Method do_http_request in the HTTPRequest class has no documentation
@gzark1
Copy link
Author

gzark1 commented Jun 15, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants