Add documentation for rust for release#242
Conversation
|
@luoyuxia Appreciate your review here. LMK how this format of doc is OK, if so, I can proceed to python and c++ docs as well. |
|
@luoyuxia Are you OK to trigger the workflow again? Thank you |
|
@leekeiabstraction Hi, I think after #263 , the document should be updated |
leekeiabstraction
force-pushed
the
rust-release-doc
branch
from
9365d92 to
13a7d88
Compare
|
@luoyuxia The PR has been updated following API changes. PTAL! |
|
@leekeiabstraction Looks good, just add a note about result handle users can opt to await or fire-and-forget, otherwise it's good 👍 it was the main idea of #263 |
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the Fluss Rust client ahead of release, and exposes a LATEST_OFFSET constant for log scanning APIs.
Changes:
- Added a comprehensive Rust client guide (
docs/rust-client.md) covering setup, admin ops, reads/writes, partitioning, and data types. - Exported
LATEST_OFFSETalongsideEARLIEST_OFFSETfor scan subscriptions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 14 comments.
| File | Description |
|---|---|
| docs/rust-client.md | New Rust client guide content and usage examples (currently contains several API/compilation mismatches). |
| crates/fluss/src/client/table/mod.rs | Exposes LATEST_OFFSET constant for consumers (re-exported via fluss::client::*). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leekeiabstraction
force-pushed
the
rust-release-doc
branch
from
13a7d88 to
93394fb
Compare
|
@luoyuxia Addressed comments, most came up because I didn't rebase changes from main. PTAL! |
|
Another round of Copilot review would be good as the previous one had a lot of noise from not rebasing from main. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Addressed copilot comment |
luoyuxia
left a comment
luoyuxia
left a comment
There was a problem hiding this comment.
@leekeiabstraction Thanks for the pr. Left some comments. PTAL
leekeiabstraction
force-pushed
the
rust-release-doc
branch
from
b4d2111 to
50628f7
Compare
|
@luoyuxia Thank you for the review. Addressed all comments, PTAL |
Purpose
Linked issue: close #241
Also ensure that LATEST_OFFSET const is exported
Tests
Manually tested individual sections