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

docs: add error handling tutorial #4983

Merged
merged 12 commits into from
Feb 14, 2023

Conversation

martinstark
Copy link
Contributor

Closes #4484

Shaka error handling is getting increasingly more complex in order to "catch them all", I've tried to put together my current understanding of handling various cases in a tutorial. To read it with github md formatting: errors.md

@avelad avelad added type: docs Improvements or fixes to documentation priority: P3 Useful but not urgent labels Feb 9, 2023
@avelad avelad added this to the v4.4 milestone Feb 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2023

Incremental code coverage: No instrumented code was changed.

@martinstark martinstark changed the title feat: add error handling tutorial chore: add error handling tutorial Feb 9, 2023
@joeyparrish joeyparrish changed the title chore: add error handling tutorial docs: add error handling tutorial Feb 9, 2023
Copy link
Member

@joeyparrish joeyparrish left a comment

Choose a reason for hiding this comment

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

This looks great! Thank you for contributing!

docs/tutorials/errors.md Outdated Show resolved Hide resolved
Copy link
Contributor

@theodab theodab left a comment

Choose a reason for hiding this comment

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

I wonder if it would be worth putting this tutorial into the main flow of tutorials.
A more thorough explanation of error handling would be useful for new developers.

Of course, if this is made part of the main tutorials I would want to do a second, pickier round of code review.

docs/tutorials/errors.md Outdated Show resolved Hide resolved
docs/tutorials/errors.md Outdated Show resolved Hide resolved
docs/tutorials/errors.md Outdated Show resolved Hide resolved
docs/tutorials/errors.md Outdated Show resolved Hide resolved
docs/tutorials/errors.md Show resolved Hide resolved
@martinstark
Copy link
Contributor Author

@theodab thanks for the great feedback, I hope I've addressed it properly. Let me know how and where to link this if it's to be part of a different document as well.

Copy link
Contributor

@theodab theodab left a comment

Choose a reason for hiding this comment

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

LGTM otherwise.

docs/tutorials/errors.md Outdated Show resolved Hide resolved
@avelad avelad requested a review from theodab February 14, 2023 08:00
@theodab
Copy link
Contributor

theodab commented Feb 14, 2023

Thanks for the tutorial!

@theodab
Copy link
Contributor

theodab commented Feb 14, 2023

Joey is busy with Chromecast-related stuff, and you've addressed his change request already, so I'm going to dismiss his review so I can merge this.

@theodab theodab dismissed joeyparrish’s stale review February 14, 2023 08:29

Change request was addressed.

@theodab theodab merged commit ac963a9 into shaka-project:main Feb 14, 2023
joeyparrish pushed a commit that referenced this pull request Mar 1, 2023
Shaka error handling is getting increasingly more complex in order to "catch them all".
This new tutorial describes both the basic method of error handling, as well as showing a few
more advanced ways to handle specific errors.

Closes #4484
joeyparrish pushed a commit that referenced this pull request Mar 1, 2023
Shaka error handling is getting increasingly more complex in order to "catch them all".
This new tutorial describes both the basic method of error handling, as well as showing a few
more advanced ways to handle specific errors.

Closes #4484
joeyparrish pushed a commit that referenced this pull request Mar 1, 2023
Shaka error handling is getting increasingly more complex in order to "catch them all".
This new tutorial describes both the basic method of error handling, as well as showing a few
more advanced ways to handle specific errors.

Closes #4484
joeyparrish pushed a commit that referenced this pull request Mar 2, 2023
Shaka error handling is getting increasingly more complex in order to "catch them all".
This new tutorial describes both the basic method of error handling, as well as showing a few
more advanced ways to handle specific errors.

Closes #4484
@github-actions github-actions bot added the status: archived Archived and locked; will not be updated label Jul 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
priority: P3 Useful but not urgent status: archived Archived and locked; will not be updated type: docs Improvements or fixes to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Intercepting non-fatal errors during .load()
4 participants