hydrosquall / hydrosquall/tiingo-python

[Enhancement] Provide More Actionable Error Messages

Open
#159 0 comments 0 reactions 0 assignees View on GitHub
good first issue hacktoberfest help wanted
Dominant language
Python
Stars
319
Forks
58
PR merge metrics
No merged PRs in 30d

Description

Based on https://github.com/hydrosquall/tiingo-python/issues/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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.