crossrefapi icon indicating copy to clipboard operation
crossrefapi copied to clipboard

Add Missing Documentation for Classes and Methods

Open gzark1 opened this issue 2 years ago • 1 comments

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 avatar Jun 15 '23 10:06 gzark1

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.

gzark1 avatar Jun 15 '23 10:06 gzark1