docs(agentic-ci): fix param name in smart_load_yaml docstring - #935
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
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>
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fix the
Args:section ofsmart_load_yamlinpackages/data-designer-config/src/data_designer/config/utils/io_helpers.pytoname the parameter the function actually accepts.
Why
The signature is
def smart_load_yaml(yaml_in: str | Path | dict) -> dict, butthe sole
Args:entry documented a parameter namedconfig. No such parameterexists — 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 isvisible 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
yaml_in, forwarded to_smart_load_yaml_internal. Noconfigparam on any code path.make test-config— 644 passed.Provenance
Found by the
docs-and-referencesdaily agentic-ci audit. Categorydocstring-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