Skip to content

Change concurrency.md heading#4875

Closed
Viicos wants to merge 1 commit intomainfrom
Viicos-patch-1
Closed

Change concurrency.md heading#4875
Viicos wants to merge 1 commit intomainfrom
Viicos-patch-1

Conversation

@Viicos
Copy link
Copy Markdown
Member

@Viicos Viicos commented Mar 27, 2026

  • Closes #

Pre-Review Checklist

  • Any AI generated code has been reviewed line-by-line by the human PR author, who stands by it.
  • No breaking changes in accordance with the version policy.
  • Linting and type checking pass per make format and make typecheck.
  • PR title is fit for the release changelog.

Pre-Merge Checklist

  • New tests for any fix or new behavior, maintaining 100% coverage.
  • Updated documentation for new features and behaviors, including docstrings for API docs.

@Viicos Viicos enabled auto-merge (squash) March 27, 2026 15:28
@github-actions github-actions bot added size: S Small PR (≤100 weighted lines) docs Improvements or additions to documentation labels Mar 27, 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 found 2 potential issues.

Open in Devin Review

@@ -1,4 +1,4 @@
# `pydantic_ai` — Concurrency
# `pydantic_ai.models.concurrency`
Copy link
Copy Markdown
Contributor

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.

@@ -1,4 +1,4 @@
# `pydantic_ai` — Concurrency
# `pydantic_ai.models.concurrency`
Copy link
Copy Markdown
Contributor

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.

@Viicos Viicos disabled auto-merge March 27, 2026 15:32
@Viicos Viicos closed this Mar 27, 2026
@Viicos Viicos deleted the Viicos-patch-1 branch March 27, 2026 15:33
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.

1 participant