Skip to content

docs(agentic-ci): document client_concurrency_mode in create_resource_provider - #886

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
agentic-ci/docs/docs-and-references-20260824-resource-provider-args
Open

docs(agentic-ci): document client_concurrency_mode in create_resource_provider#886
github-actions[bot] wants to merge 1 commit into
mainfrom
agentic-ci/docs/docs-and-references-20260824-resource-provider-args

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

What

Add the missing Args: entry for the keyword-only client_concurrency_mode
parameter in create_resource_provider
(packages/data-designer-engine/src/data_designer/engine/resources/resource_provider.py).

The parameter has existed in the signature
(client_concurrency_mode: ClientConcurrencyMode | None = None) without a
corresponding entry in the Google-style Args: block, causing docstring vs
signature drift.

Why

Detected by the docs-and-references agentic-CI audit as a signature-driven
docstring-drift finding. The fix is mechanical: the added entry notes the
parameter type and its documented default (ClientConcurrencyMode.ASYNC),
which is set explicitly a few lines below in the function body — no invented
semantics.

Testing

make test-engine — 2257 passed.

🤖 Generated with Claude Code

…_provider

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions
github-actions Bot requested a review from a team as a code owner August 24, 2026 08:23
@github-actions github-actions Bot added agentic-ci Created by agentic-ci automation agentic-ci/docs-and-references Agentic CI - docs-and-references suite labels Aug 24, 2026
@greptile-apps

greptile-apps Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds the missing client_concurrency_mode entry to the create_resource_provider docstring.

  • Documents that omitted values default to ClientConcurrencyMode.ASYNC.
  • Makes no runtime behavior changes.

Confidence Score: 5/5

The PR appears safe to merge because the documentation-only change accurately describes existing behavior.

The new docstring entry matches the implementation, which resolves an omitted concurrency mode to ClientConcurrencyMode.ASYNC, and no runtime code is changed.

Important Files Changed

Filename Overview
packages/data-designer-engine/src/data_designer/engine/resources/resource_provider.py The added parameter documentation accurately reflects the function's existing unconditional default behavior.

Reviews (1): Last reviewed commit: "docs(agentic-ci): document client_concur..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agentic-ci/docs-and-references Agentic CI - docs-and-references suite agentic-ci Created by agentic-ci automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants