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

CommentingTheCode #2

Open
mayank-git-hub opened this issue May 3, 2019 · 0 comments
Open

CommentingTheCode #2

mayank-git-hub opened this issue May 3, 2019 · 0 comments
Assignees
@mayank-git-hub
Labels
Clean Code These type of issues will be for improving the aesthetics of the code
Milestone
Basic Model Up an...

Comments

@mayank-git-hub
Copy link
Owner

Comments should be in the form

"""
Three-Four lines about the function
:input:
:param "name of parameter1": "One line description"
:param "name of parameter2": "One line description"
:return:
:param "name of parameter1": "One line description"
:param "name of parameter2": "One line description"
"""
"One line description" should contain dtype and shape of the object
@mayank-git-hub mayank-git-hub self-assigned this May 3, 2019
@mayank-git-hub mayank-git-hub added the Clean Code These type of issues will be for improving the aesthetics of the code label May 3, 2019
@mayank-git-hub mayank-git-hub changed the title Commenting the Code CommentingTheCode May 3, 2019
@mayank-git-hub mayank-git-hub added this to the Comment configs milestone May 3, 2019
@mayank-git-hub mayank-git-hub pinned this issue May 3, 2019
@mayank-git-hub mayank-git-hub unpinned this issue May 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mayank-git-hub mayank-git-hub

Labels
Clean Code These type of issues will be for improving the aesthetics of the code
Projects
None yet
Milestone
Basic Model Up and Running
Development

No branches or pull requests
3 participants
@mayank-git-hub @prantik1998 @saarthak-kapse