Add documenation for the rust client #260
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Instead of calling `AuditorClient::new()` directly, the `AuditorClientBuilder` should be used.
Instead of calling `AuditorClient::from_connection_string()` directly, the `AuditorClientBuilder` should be used.
This function is actually never used and to create a client the AuditorClientBuilder should be used anyway.
Instead of calling `AuditorClientBlocking::from_connection_string()` directly, the `AuditorClientBuilder` should be used.
Besides adding the documenation, this commit also improves the error propagation for the `build()` and `build_blocking()` methods by converting possible errors to `ClientError`.
This commit also harmonizes the types of possible that are returned in the client methods. Now, all errors have the type `ClientError`.
QuantumDancer
force-pushed
the
client-docs
branch
from
1347e99
to
93215c8
Compare
Codecov Report
@@ Coverage Diff @@
## main #260 +/- ##
==========================================
+ Coverage 50.86% 52.22% +1.35%
==========================================
Files 41 41
Lines 3049 3102 +53
==========================================
+ Hits 1551 1620 +69
+ Misses 1498 1482 -16
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
stefan-k
requested changes
Apr 5, 2023
stefan-k
requested changes
Apr 17, 2023
QuantumDancer
force-pushed
the
client-docs
branch
from
f1c1ff9
to
0d4fcc5
Compare
This allows us to reduce the usage of `map_err()` calls.
QuantumDancer
force-pushed
the
client-docs
branch
from
0d4fcc5
to
938d296
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the following changes: