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 some documentation on errors #508

Merged
merged 4 commits into from
Nov 15, 2024
Merged

Add some documentation on errors #508

merged 4 commits into from
Nov 15, 2024

Conversation

ponyisi
Copy link
Collaborator

@ponyisi ponyisi commented Nov 5, 2024

Add some documentation for the user documenting our contract for error handling in the client. We may want to revisit some of these before the 3.0.1 release. Resolves #496

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.05%. Comparing base (c58c5aa) to head (b875a1c).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #508      +/-   ##
==========================================
- Coverage   83.86%   83.05%   -0.82%     
==========================================
  Files          27       27              
  Lines        1599     1670      +71     
==========================================
+ Hits         1341     1387      +46     
- Misses        258      283      +25     
Flag Coverage Δ
unittests 83.05% <ø> (-0.82%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ponyisi ponyisi marked this pull request as ready for review November 15, 2024 10:11
@ponyisi
Copy link
Collaborator Author

ponyisi commented Nov 15, 2024

Codecov is a false positive

Copy link
Contributor

@kyungeonchoi kyungeonchoi left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks!

@kyungeonchoi kyungeonchoi merged commit 408fe81 into master Nov 15, 2024
41 of 42 checks passed
@kyungeonchoi kyungeonchoi deleted the 496_error_doc branch November 15, 2024 17:15
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.

Understand/Document current contract around incomplete/failed transforms
2 participants