portkey-python-sdk icon indicating copy to clipboard operation
portkey-python-sdk copied to clipboard

Docs: Add docstrings to the functions

Open noble-varghese opened this issue 1 year ago • 1 comments

Description:

As of now, our codebase lacks comprehensive documentation in the form of docstrings for functions. This hinders the understanding of how individual functions work, their purpose, and the expected inputs and outputs. Proper documentation is essential for maintainability and collaboration.

Tasks:

  • Review the codebase to identify functions without docstrings.
  • Add docstrings to each function, following a consistent format and style.
  • Ensure that the docstrings are clear, concise, and informative.
  • Update the project's documentation to emphasize the importance of maintaining docstrings for all new functions.

noble-varghese avatar Oct 12 '23 08:10 noble-varghese