Skip to content

docs: fix README async examples and commands#25

Merged
DiTo97 merged 1 commit intomainfrom
docs/readme-example-accuracy
Apr 15, 2026
Merged

docs: fix README async examples and commands#25
DiTo97 merged 1 commit intomainfrom
docs/readme-example-accuracy

Conversation

@DiTo97
Copy link
Copy Markdown
Owner

@DiTo97 DiTo97 commented Apr 15, 2026

Summary

  • make the README's S3 quickstart use the real async ainvoke() flow instead of a synchronous example
  • fix the composite backend snippet so it is valid async Python with proper Postgres lifecycle handling
  • align the example run command with the repo's uv run script metadata and correct the documented Postgres pool defaults

Test plan

  • uv run pytest -m unit -q
  • uv run ruff check .
  • uv run pytest -m integration -q (Docker not running in this environment)

Stack

🤖 Generated with Claude Code

Align the README with the package's actual async usage and example entrypoints so new users can copy the snippets and commands without hitting avoidable inconsistencies.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@DiTo97 DiTo97 mentioned this pull request Apr 15, 2026
4 tasks
@DiTo97 DiTo97 deleted the branch main April 15, 2026 08:33
@DiTo97 DiTo97 closed this Apr 15, 2026
@DiTo97 DiTo97 deleted the docs/readme-example-accuracy branch April 15, 2026 08:33
@DiTo97 DiTo97 restored the docs/readme-example-accuracy branch April 15, 2026 08:35
@DiTo97 DiTo97 reopened this Apr 15, 2026
@DiTo97 DiTo97 deleted the branch main April 15, 2026 08:39
@DiTo97 DiTo97 closed this Apr 15, 2026
@DiTo97 DiTo97 deleted the docs/readme-example-accuracy branch April 15, 2026 08:39
@DiTo97 DiTo97 restored the docs/readme-example-accuracy branch April 15, 2026 08:40
@DiTo97 DiTo97 reopened this Apr 15, 2026
@DiTo97 DiTo97 changed the base branch from test/integration-isolation-and-smoke-cleanup to main April 15, 2026 08:41
@DiTo97 DiTo97 merged commit 9a6d39b into main Apr 15, 2026
@DiTo97 DiTo97 deleted the docs/readme-example-accuracy branch April 15, 2026 08:41
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