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

doc: update xline client document #373

Merged
merged 7 commits into from
Aug 3, 2023
Merged

Conversation

bsbds
Copy link
Collaborator

@bsbds bsbds commented Jul 11, 2023

This PR is based on #372

Please briefly answer these questions:

  • what problem are you trying to solve? (or if there's no problem, what's the motivation for this change?)

    descibed in Update documents section in [Checklist] Providing Xline client Rust SDK #369

  • what changes does this pull request make?

    Add more detailed descriptions to some methods and types.

  • are there any non-obvious implications of these changes? (does it break compatibility with previous versions, etc)

@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.03% ⚠️

Comparison is base (f3f3101) 52.36% compared to head (7890f8a) 52.34%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #373      +/-   ##
==========================================
- Coverage   52.36%   52.34%   -0.03%     
==========================================
  Files          97       97              
  Lines       15160    15166       +6     
  Branches    15160    15166       +6     
==========================================
  Hits         7938     7938              
- Misses       6728     6733       +5     
- Partials      494      495       +1     
Files Changed Coverage Δ
xline-client/src/clients/auth.rs 0.00% <ø> (ø)
xline-client/src/clients/kv.rs 0.00% <0.00%> (ø)
xline-client/src/clients/lease.rs 0.00% <ø> (ø)
xline-client/src/clients/maintenance.rs 0.00% <ø> (ø)
xline-client/src/clients/watch.rs 0.00% <ø> (ø)
xline-client/src/lib.rs 0.80% <0.00%> (ø)
xline-client/src/types/auth.rs 0.00% <0.00%> (ø)
xline-client/src/types/kv.rs 0.00% <0.00%> (ø)
xline-client/src/types/lease.rs 0.00% <ø> (ø)
xline-client/src/types/watch.rs 0.00% <ø> (ø)

... and 3 files with indirect coverage changes

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

@bsbds bsbds force-pushed the client-doc branch 2 times, most recently from f129bee to 7ed94f5 Compare July 28, 2023 06:22
@bsbds bsbds marked this pull request as ready for review July 28, 2023 06:25
xline-client/src/clients/kv.rs Outdated Show resolved Hide resolved
xline-client/src/clients/lease.rs Show resolved Hide resolved
xline-client/src/clients/lease.rs Show resolved Hide resolved
xline-client/src/clients/lease.rs Show resolved Hide resolved
xline-client/src/clients/watch.rs Show resolved Hide resolved
xline-client/src/types/watch.rs Outdated Show resolved Hide resolved
xline-client/src/types/watch.rs Show resolved Hide resolved
xline-client/src/types/kv.rs Outdated Show resolved Hide resolved
xline-client/src/types/kv.rs Outdated Show resolved Hide resolved
xline-client/src/types/kv.rs Outdated Show resolved Hide resolved
@bsbds bsbds requested a review from Phoenix500526 August 1, 2023 11:22
Copy link
Collaborator

@themanforfree themanforfree left a comment

Choose a reason for hiding this comment

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

api_type, lease_gen and AuthService should not public to users

@bsbds
Copy link
Collaborator Author

bsbds commented Aug 2, 2023

api_type, lease_gen and AuthService should not public to users

fixed, and I moved some of the re-exported api types to src/types

Phoenix500526
Phoenix500526 previously approved these changes Aug 3, 2023
@bsbds bsbds requested a review from themanforfree August 3, 2023 06:39
@Phoenix500526 Phoenix500526 merged commit 0789ec3 into xline-kv:master Aug 3, 2023
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.

3 participants