Skip to content

docs: remove stray comma in README tools example comment#5149

Merged
DouweM merged 1 commit intopydantic:mainfrom
abhicris:contrib-bot/2026-04-21-pydantic-ai
Apr 21, 2026
Merged

docs: remove stray comma in README tools example comment#5149
DouweM merged 1 commit intopydantic:mainfrom
abhicris:contrib-bot/2026-04-21-pydantic-ai

Conversation

@abhicris
Copy link
Copy Markdown
Contributor

@abhicris abhicris commented Apr 21, 2026

What

In the README's "Tools & Dependency Injection Example" code block, the inline comment above output_type=SupportOutput read:

# The response from the agent will, be guaranteed to be a SupportOutput,

Remove the stray comma after will so the comment reads as intended:

# The response from the agent will be guaranteed to be a SupportOutput,

Why

Small README polish — the comma-splice made a landing-page code comment slightly awkward to read. The equivalent prose in docs/index.md already uses "will be guaranteed", so this aligns the README with the docs.

No code, behavior, or public API changes. One line in README.md.

Co-Authored-By: Claude Opus 4.7 [email protected]


Part of open-source blockchain work from kcolbchain.com — maintained by Abhishek Krishna. PR opened via kcolbchain contrib-bot.

The comment had "will, be guaranteed" which read awkwardly.
Drop the extra comma to match the phrasing used in docs/index.md.

Co-Authored-By: Claude Opus 4.7 <[email protected]>
@github-actions github-actions Bot added the size: S Small PR (≤100 weighted lines) label Apr 21, 2026
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@github-actions github-actions Bot added the docs Improvements or additions to documentation label Apr 21, 2026
@DouweM DouweM merged commit 73af58a into pydantic:main Apr 21, 2026
49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation size: S Small PR (≤100 weighted lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants