student-search icon indicating copy to clipboard operation
student-search copied to clipboard

Published 20 hours ago • verified publisher icon pclubiitk

Add Comments

Open yashsriv opened this issue 7 years ago • 3 comments

Currently the comments are not up to the mark in the source code.

yashsriv avatar Mar 17 '17 17:03 yashsriv

Unit Tests are Better

pallavagarwal07 avatar Jul 09 '17 05:07 pallavagarwal07

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)

adarshaj avatar Jul 18 '17 16:07 adarshaj

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)

pallavagarwal07 avatar Jul 23 '17 02:07 pallavagarwal07