Skip to content

docs: fix two stale README claims #136

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

Merged
eddietejeda merged 1 commit into from
Sep 10, 2026
Merged

docs: fix two stale README claims #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Add the crate to your `Cargo.toml`:

```toml
[dependencies]
hotdata = "0.1"
hotdata = "0.16"
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
```

Expand All @@ -29,7 +29,7 @@ By default the crate builds against `native-tls`. To use `rustls` instead:

```toml
[dependencies]
hotdata = { version = "0.1", default-features = false, features = ["rustls"] }
hotdata = { version = "0.16", default-features = false, features = ["rustls"] }
```

## Authentication
Expand Down Expand Up @@ -193,8 +193,10 @@ Errors from generated operations are returned as `hotdata::Error<T>`; builder
and configuration failures are `hotdata::ClientError`. The enhanced `query`
family returns `hotdata::QueryError` — `Overloaded` (429 retries exhausted),
`Submit` (the underlying request failed), `AsyncRequested` (use `submit_query`
for `async` queries), and `Result(ResultError)` for truncation auto-follow
failures (`TooLarge` / `Timeout` / `Incomplete` / …). Result-polling and
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

@claude claude Bot Sep 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

one-call helpers return `hotdata::AwaitResultError` / `hotdata::QueryToArrowError`.
Comment on lines +199 to 200

@claude claude Bot Sep 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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`.

The SDK's own error enums are `#[non_exhaustive]`, so match them with a wildcard
arm.
Expand All @@ -205,7 +207,7 @@ Query results can be fetched as an [Apache Arrow](https://arrow.apache.org/) IPC

```toml
[dependencies]
hotdata = { version = "0.1", features = ["arrow"] }
hotdata = { version = "0.16", features = ["arrow"] }

@claude claude Bot Sep 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

```

`ArrowResult` hands back `arrow` types, so a crate that names them must depend
Expand Down
Loading