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

Docs: Improves the module docs for error statuses. #314

Merged

polvalente merged 13 commits into elixir-grpc:master from hackvan:hackvan/docs/better_errors

Jun 8, 2023

Contributor

hackvan commented May 30, 2023 •

edited

Adds a markdown table to detail each code status and its related message.
Adds is_rpc_error/2 guard clause to check if it's an RPCError struct.
Add GRPC.Status and GRPC.RPCError unit tests

Closes #170


          Docs: Improves the module docs for error statuses.

50f09ab

Adds a markdown table to detail each code status and its related message.

Closes elixir-grpc#170

hkrutzer reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

hackvan added 3 commits

May 30, 2023 10:52


          Docs: Updates the reference link to see more details about GRPC statu…

a493936

…s code


          Feat: Adds is_rpc_error/2 guard clause to check if it's an RPCError…

36f075e

… struct

Fix and add some missing specs.


          Test: Add GRPC.Status and GRPC.RPCError unit tests

b194284

hackvan marked this pull request as ready for review

May 30, 2023 17:53

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

hkrutzer reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/error_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/status_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/status_test.exs Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/error_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/error_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/error_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

test/grpc/status_test.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/status.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/error.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

Contributor

polvalente left a comment

PR looks great overall! I just suggested some minor changes and then we can merge!

hackvan and others added 5 commits

May 31, 2023 11:58


          Fix: Applies suggestions from the code review

f48e9d6

* Adds examples about `is_rpc_error/2` clause in `GRPC.RPCError` module doc.
* Improves @SPEC with variable names.
*  Renames error_test.exs to rpc_error_test.exs file.
* Fixes markdown table syntax in `GRPC.Status` module doc.


          Fix: Use mix format on status_test.exs file

bdd6a40


          Test: Refactor tests related to the expected status code and expected…

4b779a4

… error message using a common factory function.


          update ex_doc and some formatting

9317f54


          docs: improve docs for error handling


          test: improve testing

1ecc397

polvalente approved these changes

View reviewed changes

polvalente added 3 commits

June 8, 2023 05:04


          Merge branch 'master' into hackvan/docs/better_errors

26a43d3


          dialyzer

fe66384


          Merge branch 'hackvan/docs/better_errors' of github.com:hackvan/grpc …

ef50986

…into hackvan/docs/better_errors

polvalente merged commit 435bfd7 into elixir-grpc:master

19 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment