docs: fix two stale README claims - #136
Merged
Merged
Conversation
- Install snippets pinned hotdata = "0.1" in three places; the crate is
at 0.16.0, and cargo resolves "0.1" to the old 0.1.x line. Now "0.16".
- The QueryError paragraph listed four variants as if complete
("... and Result(ResultError)"), omitting Async (server fell back to
asynchronous execution, HTTP 202) and Poll (API error while polling
during auto-follow) — src/query.rs has six.
eddietejeda
requested review from
shefeek-jinnah
and removed request for
a team
September 10, 2026 03:02
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| ```toml | ||
| [dependencies] | ||
| hotdata = { version = "0.1", features = ["arrow"] } | ||
| hotdata = { version = "0.16", features = ["arrow"] } |
Contributor
There was a problem hiding this comment.
nit: the same stale pin survives in src/arrow.rs:29 (not blocking).
That module doc carries hotdata = { version = "0.1", features = ["arrow"] }. docs.rs renders it with all-features = true, so a reader of the arrow module page still gets the 0.1.x pin this PR removes from README.md. Update src/arrow.rs:29 to version = "0.16" for consistency.
| for `async` queries), `Async` (the server fell back to asynchronous execution | ||
| with a 202; the acknowledgement is passed through), `Poll` (an API error while | ||
| polling during auto-follow), and `Result(ResultError)` for truncation | ||
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling and |
Contributor
There was a problem hiding this comment.
super nit: this line runs to 86 columns (not blocking). Surrounding prose wraps at 80.
Suggested change
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling and | |
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling | |
| and |
Comment on lines
+199
to
200
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling and | ||
| one-call helpers return `hotdata::AwaitResultError` / `hotdata::QueryToArrowError`. |
Contributor
There was a problem hiding this comment.
super nit: use this reflow instead of the single-line suggestion above (not blocking). The single-line version leaves and alone on its own line.
Suggested change
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling and | |
| one-call helpers return `hotdata::AwaitResultError` / `hotdata::QueryToArrowError`. | |
| auto-follow failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling | |
| and one-call helpers return `hotdata::AwaitResultError` / | |
| `hotdata::QueryToArrowError`. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
README accuracy audit against source at v0.16.0 (same flow as hotdata-dev/hotdata-ibis#55).
hotdata = "0.1"in three places — cargo resolves that to the old 0.1.x line, which predates the auth changes this README itself describes. Now"0.16"QueryErrorwas phrased as a complete list with 4 variants;src/query.rshas 6 — addedAsyncandPollEverything else verified against source, including the handle table (the 0.15.0 removals are correctly absent). One claim left unverified: "Rust 1.74+" — no
rust-versionin Cargo.toml and no MSRV check in CI.