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.

Sign up for GitHub

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

Jump to bottom

Set and add docstrings style guide for better documentation #20

Open
thatvideoshopguy opened this issue Apr 12, 2023 · 2 comments
Open

Set and add docstrings style guide for better documentation #20

thatvideoshopguy opened this issue Apr 12, 2023 · 2 comments

Comments

@thatvideoshopguy
Copy link
Contributor

Description

Improve the documentation and understanding of the codebase by adding docstrings to all functions. We should pick a specific docstring style, like Google Style Guide and stick to it. This will provide valuable information for developers working with the code.
@shashankshet
Copy link

by looking at the code it looks like docstrings are already added to the functions, can you please provide more details on which functions we plan to add docstrings?

@prashantpadhy
Copy link

can you assign it to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@thatvideoshopguy @shashankshet @prashantpadhy