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

Add screenshot of a panic message and backtrace in a browser's developer console #1

Closed
fitzgen opened this issue Jun 7, 2018 · 5 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@fitzgen
Copy link
Member

fitzgen commented Jun 7, 2018

So users get an idea what to expect.

@fitzgen fitzgen added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 7, 2018
@migerh
Copy link
Contributor

migerh commented Jul 17, 2018

Something like this?
panic_hook

@fitzgen
Copy link
Member Author

fitzgen commented Jul 17, 2018

@migerh exactly like that!

Also, a "before" version to go with the nicer "after" version would be nice to drive it home :)

@migerh
Copy link
Contributor

migerh commented Jul 18, 2018

Sure:
without_panic_hook
with_panic_hook

Also, I noticed that in Chrome I get the (almost, minus the hook of course) same stacktrace with and without the panic hook - BUT with the panic hook I get a nice message that helps with the debugging. Without the hook only RuntimeError: unreachable is reported.

@fitzgen
Copy link
Member Author

fitzgen commented Jul 18, 2018

@migerh so would you like to send a PR adding these images to the README? That's the end goal of this issue -- sorry if that wasn't clear.

Re: chrome vs firefox stacks, I think it is a bug that firefox does not have a stack attached to the RuntimeError.

@migerh
Copy link
Contributor

migerh commented Jul 19, 2018

The only thing unclear until your comment was where to add the screenshots - README or docs? 😉

I added them to the README now. If you want them in the docs as well we could use the direct link to the images in the merge commit once the PR is merged and add them there as well.

@fitzgen fitzgen closed this as completed Aug 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants