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 top-level documentation on reporting errors #466

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Conversation

Enet4
Copy link
Collaborator

@Enet4 Enet4 commented Oct 31, 2024

Resolves #464. I'm open to the possibility of shortening the example code.

@Enet4 Enet4 requested a review from shepmaster October 31, 2024 18:50
@Enet4 Enet4 self-assigned this Oct 31, 2024
Copy link

netlify bot commented Oct 31, 2024

Deploy Preview for shepmaster-snafu ready!

Name Link
🔨 Latest commit 531a3b2
🔍 Latest deploy log https://app.netlify.com/sites/shepmaster-snafu/deploys/67293ab958bd0e0008eb6a57
😎 Deploy Preview https://deploy-preview-466--shepmaster-snafu.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@alerque alerque left a 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.

@Enet4
Copy link
Collaborator Author

Enet4 commented Nov 1, 2024

@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 macro@report and Report.

Copy link

@alerque alerque left a 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.
Copy link
Owner

@shepmaster shepmaster left a 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.

@shepmaster shepmaster merged commit 90991b6 into main Nov 4, 2024
12 checks passed
@shepmaster shepmaster deleted the doc/report branch November 4, 2024 21:25
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.

Mention Report in the top level docs
3 participants