docs: fix on_llm_start docstring to match actual method signature#428
Open
themavik wants to merge 1 commit intoawslabs:mainfrom
Open
docs: fix on_llm_start docstring to match actual method signature#428themavik wants to merge 1 commit intoawslabs:mainfrom
themavik wants to merge 1 commit intoawslabs:mainfrom
Conversation
The docstring for `AgentCallbacks.on_llm_start` documented parameters that don't exist in the method signature (`agent_name`, `messages`) and omitted the actual parameter name (`name`). - Changed `agent_name` to `name` to match the method signature - Removed `messages` parameter (not part of the signature) - Updated `payload_input` description for clarity Fixes awslabs#360
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
1 participant
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.
Summary
The
AgentCallbacks.on_llm_startdocstring documents parameters that don't exist in the method signature and uses wrong names for those that do.Changes
agent_namein docstring changed toname(matching the actual parameter name)messagesparameter from docstring (not part of the method signature;messagesis a parameter onon_agent_start, noton_llm_start)payload_inputdescription to say "LLM's input" instead of "agent's input"Test Plan
Fixes #360