Conversation
| @@ -1,4 +1,4 @@ | |||
| # `pydantic_ai` — Concurrency | |||
| # `pydantic_ai.models.concurrency` | |||
There was a problem hiding this comment.
🟡 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.
Was this helpful? React with 👍 or 👎 to provide feedback.
| @@ -1,4 +1,4 @@ | |||
| # `pydantic_ai` — Concurrency | |||
| # `pydantic_ai.models.concurrency` | |||
There was a problem hiding this comment.
🚩 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.
Was this helpful? React with 👍 or 👎 to provide feedback.
Pre-Review Checklist
make formatandmake typecheck.Pre-Merge Checklist