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.

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

Add delete_object fn to client #7

Merged
merged 3 commits into from
Aug 17, 2023
Merged

Add delete_object fn to client #7

merged 3 commits into from
Aug 17, 2023

Conversation

G8XSU
Copy link
Collaborator

@G8XSU G8XSU commented Aug 17, 2023

No description provided.

@G8XSU G8XSU requested a review from jkczyz August 17, 2023 01:37
@G8XSU G8XSU mentioned this pull request Aug 17, 2023
Open
31 tasks
tnull
tnull approved these changes Aug 17, 2023
View reviewed changes
Copy link
Contributor

@tnull tnull left a comment

Choose a reason for hiding this comment

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

LGTM

@tnull
Copy link
Contributor

tnull commented Aug 17, 2023

Unrelatedly, note there are unused import of VssClient/VssError in lib.rs that could be removed: https://github.com/G8XSU/vss-rust-client/blob/928f91e68c3e2afeb50a9f5a5d3c92a0db6f4227/src/lib.rs#L13C1-L14.

jkczyz
jkczyz reviewed Aug 17, 2023
View reviewed changes
Copy link

@jkczyz jkczyz left a comment

Choose a reason for hiding this comment

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

LGTM aside from some comments on doc consistency.

src/types.rs Outdated
@@ -93,10 +96,57 @@ pub struct PutObjectRequest {
/// read-after-update consistency guarantees.
#[prost(message, repeated, tag = "3")]
pub transaction_items: ::prost::alloc::vec::Vec<KeyValue>,
/// Items to be deleted as a result of this PutObjectRequest.
Copy link

Choose a reason for hiding this comment

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

Need ticks on PutObjectRequest

Copy link
Collaborator Author

@G8XSU G8XSU Aug 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

All ticks will be auto-fixed after lightningdevkit/vss-server#16 :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Generated/updated docs after merging above.

src/types.rs Outdated Show resolved Hide resolved
src/types.rs Outdated Show resolved Hide resolved
src/types.rs Outdated Show resolved Hide resolved
@G8XSU
Copy link
Collaborator Author

G8XSU commented Aug 17, 2023

Unrelatedly, note there are unused import of VssClient/VssError in lib.rs that could be removed: https://github.com/G8XSU/vss-rust-client/blob/928f91e68c3e2afeb50a9f5a5d3c92a0db6f4227/src/lib.rs#L13C1-L14.

They are not unused, currently being used for doc-links.

@tnull
Copy link
Contributor

tnull commented Aug 17, 2023

Unrelatedly, note there are unused import of VssClient/VssError in lib.rs that could be removed: https://github.com/G8XSU/vss-rust-client/blob/928f91e68c3e2afeb50a9f5a5d3c92a0db6f4227/src/lib.rs#L13C1-L14.

They are not unused, currently being used for doc-links.

Ah, no need to actually import them for this, you can just add markdown references to the end of the doc comment, just like this:

/// Implements a thin-client ([`VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
///
/// [`VssClient`]: crate::client::VssClient

@G8XSU
Copy link
Collaborator Author

G8XSU commented Aug 17, 2023

Unrelatedly, note there are unused import of VssClient/VssError in lib.rs that could be removed: https://github.com/G8XSU/vss-rust-client/blob/928f91e68c3e2afeb50a9f5a5d3c92a0db6f4227/src/lib.rs#L13C1-L14.

They are not unused, currently being used for doc-links.

Ah, no need to actually import them for this, you can just add markdown references to the end of the doc comment, just like this:

/// Implements a thin-client ([`VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
///
/// [`VssClient`]: crate::client::VssClient

directly used path in docs

@G8XSU G8XSU merged commit 7040c2b into lightningdevkit:main Aug 17, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkczyz jkczyz jkczyz left review comments

@tnull tnull tnull approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@G8XSU @tnull @jkczyz