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

Add Comments #2

Open
yashsriv opened this issue Mar 17, 2017 · 3 comments
Open

Add Comments #2

yashsriv opened this issue Mar 17, 2017 · 3 comments

Comments

@yashsriv
Copy link
Collaborator

Currently the comments are not up to the mark in the source code.
@pallavagarwal07
Copy link
Contributor

Unit Tests are Better

@adarshaj
Copy link
Member

From the hacker's perspective the tests are good, but for a person who just wants to use your library as a blackbox, comments are more valuable (preferably ones that can be output to some sort of browsable documentation -- like readthedocs)

@pallavagarwal07
Copy link
Contributor

Yes, but this isn't a library, right?
For usage as a blackbox binary -> README.md / documentation of binary
For usage of an API -> comments = documentation per function
For someone modifying code (which I think would be this case? ) -> Tests (+ comments)

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
@adarshaj @pallavagarwal07 @yashsriv