Skip to content

docs: drop Args entries for parameters the functions do not take - #14439

Open
darkdi wants to merge 2 commits into
langflow-ai:release-1.12.0from
darkdi:fix/args-not-in-signature
Open

docs: drop Args entries for parameters the functions do not take#14439
darkdi wants to merge 2 commits into
langflow-ai:release-1.12.0from
darkdi:fix/args-not-in-signature

Conversation

@darkdi

@darkdi darkdi commented Aug 5, 2026

Copy link
Copy Markdown

Nine docstrings list a parameter under Args: that the function does not take. Most are leftovers from a rename or from an argument that moved onto self; nothing here changes behaviour.

The ones worth a second look:

  • search_templates in agentic/mcp/server.py documents tags, and this docstring is what an MCP client shows the model. An agent reading it will happily call the tool with tags=[...] and get a TypeError.
  • ContentSizeLimitMiddleware documents max_content_size and exception_cls; the __init__ here only takes app. Those two exist upstream in content-size-limit-asgi, not in this adaptation.
  • _validate_key documents s, the argument is key — renamed the entry rather than dropping it.

The rest are single stale entries: port in load/utils.get_flow and lfx/load/utils.upload_file, inputs in get_llm, flow_name in _delete_cached_flow, flow_name_selected in get_required_data, outputs in map_outputs, parent_node_map in filter_vertices_up_to_vertex.

Two more of the same kind sit in lfx-amazon and lfx-datastax. I left them out: the bundle release-plan check wants a version bump on both packages, and the update script re-resolves uv.lock on top of that. Three lines of comment are not worth two package releases — happy to send them separately if you would rather have them.

Every one was opened and read against its signature. ruff check and ruff format --check are clean on all touched files, same as before the change.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The changes update outdated docstrings across backend, bundle, and core modules. They remove obsolete parameter descriptions and correct current parameter documentation. No executable behavior, function signatures, or public declarations changed.

Changes

Documentation alignment

Layer / File(s) Summary
Remove obsolete parameter documentation
src/backend/base/langflow/agentic/mcp/server.py, src/backend/base/langflow/load/utils.py, src/backend/base/langflow/middleware.py, src/bundles/datastax/..., src/lfx/src/lfx/base/tools/run_flow.py, src/lfx/src/lfx/graph/graph/utils.py, src/lfx/src/lfx/load/utils.py
Removed outdated parameter descriptions from multiple function and method docstrings.
Align current parameter descriptions
src/bundles/amazon/.../s3_bucket_uploader.py, src/lfx/src/lfx/utils/concurrency.py, src/lfx/src/lfx/base/models/model.py, src/lfx/src/lfx/custom/custom_component/component.py
Updated path-setting documentation and corrected parameter names. Removed obsolete descriptions from component and model docstrings.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: enhancement

Suggested reviewers: ogabrielluiz

🚥 Pre-merge checks | ✅ 9
✅ Passed checks (9 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Test Coverage For New Implementations ✅ Passed The commit changes only docstrings in 11 existing Python files, with no executable behavior changes and no test paths changed; implementation and regression coverage are not applicable.
Test Quality And Coverage ✅ Passed The commit changes only 11 existing docstrings (22 deletions, 2 wording fixes); it adds no implementations or behavior, so new functional tests are not applicable.
Test File Naming And Structure ✅ Passed The commit changes 11 production source files only and adds or modifies no backend, frontend, or integration test files; this naming and structure check is not applicable.
Excessive Mock Usage Warning ✅ Passed The patch changes only 11 production docstrings. No test files or mock-related additions are present, so excessive mock usage is not applicable.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: removing outdated docstring argument entries for parameters absent from function signatures.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 5, 2026
The bundle release-plan check requires a version bump for lfx-amazon and
lfx-datastax whenever their source changes, and the update script also
re-resolves uv.lock. Three lines of docstring are not worth shipping two
package releases and a 1200-line lock diff.
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant