docs: drop Args entries for parameters the functions do not take - #14439
Open
darkdi wants to merge 2 commits into
Open
docs: drop Args entries for parameters the functions do not take#14439darkdi wants to merge 2 commits into
darkdi wants to merge 2 commits into
Conversation
Contributor
WalkthroughThe 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. ChangesDocumentation alignment
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 9✅ Passed checks (9 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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.
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.
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 ontoself; nothing here changes behaviour.The ones worth a second look:
search_templatesinagentic/mcp/server.pydocumentstags, and this docstring is what an MCP client shows the model. An agent reading it will happily call the tool withtags=[...]and get aTypeError.ContentSizeLimitMiddlewaredocumentsmax_content_sizeandexception_cls; the__init__here only takesapp. Those two exist upstream incontent-size-limit-asgi, not in this adaptation._validate_keydocumentss, the argument iskey— renamed the entry rather than dropping it.The rest are single stale entries:
portinload/utils.get_flowandlfx/load/utils.upload_file,inputsinget_llm,flow_namein_delete_cached_flow,flow_name_selectedinget_required_data,outputsinmap_outputs,parent_node_mapinfilter_vertices_up_to_vertex.Two more of the same kind sit in
lfx-amazonandlfx-datastax. I left them out: the bundle release-plan check wants a version bump on both packages, and the update script re-resolvesuv.lockon 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 checkandruff format --checkare clean on all touched files, same as before the change.