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

Improve error message and README example #6

Merged
merged 2 commits into from
Jun 14, 2024

Conversation

felixge
Copy link
Member

@felixge felixge commented Jun 13, 2024

  • Remove the reference to failing endpoint. It's confusing and redundant (the search and download profiles part of the error message is sufficient to debug which endpoint is being hit)
  • Improve the error hint to suggest checking that the account has the right data.
  • Improve README example to use double quotes

Before:

ERR search and download profiles: POST /api/unstable/profiles/gopgo: 404 Not Found: please check that your DD_API_KEY, DD_APP_KEY and DD_SITE env vars are set correctly and that your account has profiles matching your query

After:

Jun 13 20:02:05.406 ERR search and download profiles: 404 Not Found: please check that your DD_API_KEY, DD_APP_KEY and DD_SITE env vars are set correctly and that your account has profiles matching your query

See JIRA for more information.

@felixge felixge changed the title improve error message Improve error message and README example Jun 13, 2024
Copy link

@r1viollet r1viollet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@felixge felixge merged commit 709611d into main Jun 14, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

3 participants