Add comments to make the working of the functions clear.#1
Open
pratap-is-here wants to merge 2 commits into
Open
Add comments to make the working of the functions clear.#1pratap-is-here wants to merge 2 commits into
pratap-is-here wants to merge 2 commits into
Conversation
I added comments for every function to make it's working clear and also information about the rule which a function implements.
|
I know this library may no longer be maintained but this could be useful for future reference. I suppose it should be converted to docstring though |
Author
|
Thanks for the suggestion. I changed the comments to doc string. Let me know if it's better now. |
|
That's actually pretty awesome, thanks for doing that. @jedijulia, it would be great if this could be merged. What do you thing? |
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.
I added comments for every function to make it's working clear and I also added information about the rule a function implements.