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

Added Comments and explanation to functions #52

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

arshkumarsingh
Copy link

Added some comments and docstrings I thought were useful and would help in this program's maintainability in the future

@mcdallas
Copy link
Owner

Hey @arshkumarsingh, thanks for the contribution. The library is indeed poorly documented but adding an LLM created comment above every line of code is the opposite extreme. I don’t think that
image
helps anyone, it just adds bloat. Maybe we could just add the docstrings and get rid of the comments

@arshkumarsingh
Copy link
Author

Thanks for the reply and advice, intention was not to bloat but will fix it and revert
👍

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

Successfully merging this pull request may close these issues.

2 participants