Added Comments and explanation to functions #52
Open
arshkumarsingh wants to merge 3 commits intomcdallas:masterfrom
Open
Added Comments and explanation to functions #52arshkumarsingh wants to merge 3 commits intomcdallas:masterfrom
arshkumarsingh wants to merge 3 commits intomcdallas:masterfrom
Conversation
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 |
Author
|
Thanks for the reply and advice, intention was not to bloat but will fix it and revert |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added some comments and docstrings I thought were useful and would help in this program's maintainability in the future