Skip to content

Change concurrency.md heading #4875

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

Closed
Viicos wants to merge 1 commit into from
+1 −1
Closed

Change concurrency.md heading #4875

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
2 changes: 1 addition & 1 deletion docs/api/concurrency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `pydantic_ai` — Concurrency
# `pydantic_ai.models.concurrency`
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot Mar 27, 2026

Choose a reason for hiding this comment

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

🟡 Page title claims pydantic_ai.models.concurrency module but ::: directives reference pydantic_ai namespace

The title was changed to pydantic_ai.models.concurrency, implying this page documents that specific module (matching the pattern of docs/api/models/fallback.md and docs/api/models/instrumented.md which use ::: pydantic_ai.models.fallback etc.). However, all ::: directives on lines 3–15 still reference the top-level pydantic_ai namespace (e.g., ::: pydantic_ai.ConcurrencyLimitedModel). Every other API doc in docs/api/ has consistent title-to-directive paths (e.g., docs/api/agent.md has title pydantic_ai.agent and ::: pydantic_ai.agent; docs/api/capabilities.md has title pydantic_ai.capabilities and ::: pydantic_ai.capabilities). This inconsistency could mislead users about the canonical import path for these symbols.

Prompt for agents 
The title in docs/api/concurrency.md line 1 was changed to `pydantic_ai.models.concurrency` but the ::: directives on lines 3-15 still reference the `pydantic_ai` top-level namespace (e.g., `::: pydantic_ai.ConcurrencyLimitedModel`). To be consistent with the rest of the API docs, either:

1. Revert the title to something that matches the pydantic_ai namespace (e.g. `# pydantic_ai — Concurrency` or similar), or
2. Move the file to docs/api/models/concurrency.md and change the ::: directives to use `pydantic_ai.models.concurrency` (like docs/api/models/fallback.md does with `::: pydantic_ai.models.fallback`), and update the nav entry in mkdocs.yml accordingly.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot Mar 27, 2026

Choose a reason for hiding this comment

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

🚩 File location inconsistency with new module-path title

The file lives at docs/api/concurrency.md rather than docs/api/models/concurrency.md, yet the new title uses a pydantic_ai.models.concurrency module path. Other model-specific API docs (e.g., docs/api/models/fallback.md, docs/api/models/instrumented.md) live under docs/api/models/ and use pydantic_ai.models.X paths in both title and ::: directives. Meanwhile, other top-level docs/api/*.md files use pydantic_ai.X titles matching their ::: directives. This file now sits in an awkward middle ground — it may warrant being moved to docs/api/models/ with updated directives, or the title should be kept consistent with the pydantic_ai namespace used in its ::: directives.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


::: pydantic_ai.ConcurrencyLimitedModel

Expand Down
Loading