Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Please document exceptions in the API. #7

Open
tedgin opened this Issue Nov 21, 2012 · 2 comments

Comments

Projects
None yet
2 participants

tedgin commented Nov 21, 2012

When calling the connect! function with an known host name, it throws an exception. I guess I shouldn't have been surprised.

For each function in the API would you mind adding the possible exceptions that may occur, so that clients know what to trap?

Owner

michaelklishin commented Nov 21, 2012

The problem is that there is half a dozen of I/O exceptions that may occur, some having multiple causes. We will see.

tedgin commented Nov 29, 2012

Not every possible exception type that can be thrown from a function needs to be documented. Just the causes that make sense from treating the function as a black box. For instance connect! throws an exception when it fails to connect to the server. It might even be good enough to indicate which functions throws any exception.

Overall, the library has great documentation. It is one the best documented clojure projects I've seen. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment