Skip to content

Comments

Improve Docs#34

Merged
bh2smith merged 2 commits intomainfrom
better-docs
Feb 14, 2026
Merged

Improve Docs#34
bh2smith merged 2 commits intomainfrom
better-docs

Conversation

@bh2smith
Copy link
Collaborator

@cursor
Copy link

cursor bot commented Feb 14, 2026

PR Summary

Low Risk
Primarily documentation and public API ergonomics (re-exports and error trait impl) with no changes to request/response logic; low runtime risk but minor breaking risk for users relying on old module paths.

Overview
Improves public documentation by rewriting the README and adding extensive crate/module rustdoc, including clearer quick-start examples, auth/parameter guidance, and deserialization helpers.

Enhances API ergonomics by re-exporting common types at the crate root (DuneClient, DuneRequestError, Parameter, ExecutionStatus, GetResultResponse) and by making DuneRequestError implement Display + std::error::Error for better propagation/logging.

Mostly refines docs/comments on DuneClient, Parameter, parse_utils, and response types, and updates examples to use the new root-level imports and no_run doctests.

Written by Cursor Bugbot for commit 1c6fb7f. Configure here.

@bh2smith bh2smith merged commit 36f5c08 into main Feb 14, 2026
1 check passed
@bh2smith bh2smith deleted the better-docs branch February 14, 2026 06:49
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.

1 participant