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

[Enhancement] Provide More Actionable Error Messages #159

Open
hydrosquall opened this issue Sep 13, 2018 · 0 comments
Open

[Enhancement] Provide More Actionable Error Messages #159

hydrosquall opened this issue Sep 13, 2018 · 0 comments

Comments

@hydrosquall
Copy link
Owner

Based on #157, it appears that when API calls return non-200 status codes, that the response may not necessarily be JSON parse-able.

We should find out whether there is a more specific error message coming from the API that can be provided to the user, and print those out accordingly.

See Taylor Barnett's "Guide to Technical Writing" for more tips on making error messages with the 3 H's in mind: humble, helpful, and human.

https://blog.stoplight.io/writing-documentation-when-you-arent-a-technical-writer-part-two-59997587cc2a?gi=67155dd06a2c

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

No branches or pull requests

1 participant