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

question: How to write examples? #167

Open
duesee opened this issue May 5, 2024 · 0 comments
Open

question: How to write examples? #167

duesee opened this issue May 5, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested

Comments

@duesee
Copy link
Owner

duesee commented May 5, 2024

I feel that we should write "production ready" examples. Handling (recoverable) errors, never panicking, etc.

The reason is that I'd like us to feel the error handling pain first. Also, examples tend to get copied all over the place, maybe we should anticipate that.

One downside of handling errors is that -- w/o further ado, logging, etc. -- it's more difficult to pin down errors while unwrap instantly points you to the offending line. But, given that examples are small, this might not be an issue.

@duesee duesee added help wanted Extra attention is needed good first issue Good for newcomers question Further information is requested labels May 5, 2024
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 question Further information is requested
Projects
Status: No status
Development

No branches or pull requests

1 participant