2 ms·
"I realize complaining about the lack of documentation in some open source projects is like complaining that there is no foie gras at a friend’s free dinner par
by greenyoda 14y ago
"I realize complaining about the lack of documentation in some open source projects is like complaining that there is no foie gras at a friend’s free dinner party"
Actually, it's more like not having chairs at a dinner party. It's a significant discomfort, not a lack of a luxury.
"The Spring Security documentation says it best…
It is much easier to debug your application or to work out where a problem lies if you don’t treat the external code you are working with as a black box which you never look inside. The first thing you should do when an exception you don’t understand is thrown from an open source library is jump to the class and line number and take a look to figure out what the code was doing there. Otherwise you’re missing out on much of the benefit of using open source code."
Sorry, but it's a lot easier to debug your application if you have documentation that tells you under what conditions the library throws a particular exception.
Having to understand the source code of a library to be able to figure out its behavior eradicates much of the benefit of using a library in the first place. And the average product these days relies on so much open source software that you can't possibly have the time to dig through the sources to solve every little problem. Would the author of this statement be happy if he had to dig through Linux kernel code, or Apache web server code, or the code of the dozens of Java libraries that Spring is dependent on? I don't think so.