-
Notifications
You must be signed in to change notification settings - Fork 61
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 top-level documentation on reporting errors #466
Conversation
✅ Deploy Preview for shepmaster-snafu ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a potential consumer of the docs this shows me roughly what i could do but it is not at all apparent from the docs what the result output would be or why i would want to use this over done alternative.
@alerque Please see whether the new version of the documentation explains the situation better. At this point it is a matter of striking a balance between explaining the purpose of this mechanism and not becoming too redundant with the contents in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that is much better!
Demonstrate how source errors are shown and show the differences between `Display` and `Debug` outputs.
4311efb
to
531a3b2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I just squashed the commits and reworded the commit message a bit.
Resolves #464. I'm open to the possibility of shortening the example code.