joomcode / errorx

A comprehensive error handling library for Go
MIT License
1.12k stars 29 forks source link

Improve Documentation #20

Open venkatvghub opened 5 years ago

venkatvghub commented 5 years ago

I am trying to use your package for certain use cases and i am confused beyond a point. For instance, i have scenarios for custom errors and error types or error codes etc. I am looking at adding namespaces etc and your documentation is not helping me move forward. Could someone please address it and help me or developers like me understand how to go about using your library better?

PeterIvanov commented 5 years ago

Thank you for the feedback. It would help if you could be a little more specific about the kind of documentation you find unsatisfactory or lacking. Would more examples help? Are some of the godoc comments badly phrased?