Skip to content

docs(agentic-ci): fix param name in smart_load_yaml docstring - #935

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
agentic-ci/docs/docs-and-references-20260914-smart-load-yaml-arg
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
agentic-ci/docs/docs-and-references-20260914-smart-load-yaml-arg

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

What

Fix the Args: section of smart_load_yaml in
packages/data-designer-config/src/data_designer/config/utils/io_helpers.py to
name the parameter the function actually accepts.

     Args:
-        config: The config as a dict, yaml string, or yaml file path.
+        yaml_in: The config as a dict, yaml string, or yaml file path.

Why

The signature is def smart_load_yaml(yaml_in: str | Path | dict) -> dict, but
the sole Args: entry documented a parameter named config. No such parameter
exists — the name appears to predate a rename. This is a public config-package
helper (imported by data_designer.cli.utils.config_loader), so the drift is
visible to anyone reading the API docs or trying to call it by keyword.

The description after the colon is still accurate and is left untouched; only
the parameter-name token changes. The docstring's bare-name style (no
parenthesized type) is preserved.

Verification

  • Re-read the function: one positional param, yaml_in, forwarded to
    _smart_load_yaml_internal. No config param on any code path.
  • make test-config — 644 passed.

Provenance

Found by the docs-and-references daily agentic-ci audit. Category
docstring-drift, ranked first this run at confidence 0.75 / severity medium —
the only backlog finding where the docstring names a parameter that does not
exist (the rest are omissions).

🤖 Generated with Claude Code

The Args: section documented a param named `config`, but the function
signature takes `yaml_in`. Rename the token only; the description was
already accurate.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
github-actions Bot requested a review from a team as a code owner September 14, 2026 08:27
@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 Sep 14, 2026
@greptile-apps

greptile-apps Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

The PR appears safe to merge because the documentation-only correction accurately matches the function signature.

Summary

  • Renames the stale config argument entry to yaml_in.
  • Makes no runtime or behavioral changes.

Reviews (1) · Last reviewed commit: "docs(agentic-ci): fix param name in smar..."

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