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.

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

Add thrown exceptions in documentation #11

Open
yvele opened this issue Oct 29, 2014 · 0 comments
Open

Add thrown exceptions in documentation #11

yvele opened this issue Oct 29, 2014 · 0 comments

Comments

@yvele
Copy link

yvele commented Oct 29, 2014

Can you improve the documentation and add what exceptions are thrown and why?
For example if you use get with a non existing reference token, the function will throw an Error the a message saying "Invalid reference token: foo".

It's too bad I have to browse the code or the unit tests to figure out what is the basic behavior of the functions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant