Skip to content

DOC: add more info to failure message #13293

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

Merged
merged 1 commit into from
Apr 18, 2019
Merged

DOC: add more info to failure message #13293

merged 1 commit into from
Apr 18, 2019

Conversation

mattip
Copy link
Member

@mattip mattip commented Apr 9, 2019

Add version information to the error message when import fails. Also shorten the message and de-emphasize build failures from a git checkout

Copy link
Member

@eric-wieser eric-wieser left a comment

Choose a reason for hiding this comment

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

Moving the git repository message to last seems like a good idea to me

@@ -41,20 +41,12 @@
except ImportError as exc:
import sys
msg = """

IMPORTANT: PLEASE READ THIS FOR ADVICE ON HOW TO SOLVE THIS ISSUE!
Copy link
Member

Choose a reason for hiding this comment

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

Keeping this line gives us a nice filter for people who pasted the message without thinking, even if it is a little ugly. Happy to go either way on this

Copy link
Member Author

Choose a reason for hiding this comment

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

restoring

@charris
Copy link
Member

charris commented Apr 13, 2019

LGTM. We might want to put a "when things go wrong" page somewhere listing common problems, maybe with links to the issues, but that is separate from this PR.

@mattip mattip merged commit 3c3ba10 into numpy:master Apr 18, 2019
@mattip mattip deleted the errmsg branch May 20, 2019 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants