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

Docs: Add docstrings to the functions #44

Open
noble-varghese opened this issue Oct 12, 2023 · 1 comment
Open

Docs: Add docstrings to the functions #44

noble-varghese opened this issue Oct 12, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@noble-varghese
Copy link
Contributor

noble-varghese commented Oct 12, 2023

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 noble-varghese added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 12, 2023
@AnshumanAI
Copy link

Kindly assign this to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants