Skip to content

Update docs for Twirp Errors #368

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 23, 2022
Merged

Update docs for Twirp Errors #368

merged 3 commits into from
Sep 23, 2022

Conversation

marioizquierdo
Copy link
Contributor

Update docs for Twirp Errors:

  • Organize for better readability: Overview; Error codes; Server side; Client side; Metadata.
  • Update examples using new error constructors and idioms.
  • Show common error codes first, and include a link to see all other codes in the spec.
  • Improve links to source code on relevant examples.
  • Explain how vanilla (non-twirp) errors are wrapped as internal errors with more detail.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@wmatveyenko wmatveyenko merged commit 3519a9a into main Sep 23, 2022
@wmatveyenko wmatveyenko deleted the error_docs_upadte branch September 23, 2022 17:10
@wmatveyenko
Copy link
Contributor

Thanks for your contribution!

@marioizquierdo marioizquierdo mentioned this pull request Sep 23, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marioizquierdo @wmatveyenko