docs: drop nonexistent 'context' param from RealtimeRunner.__init__ docstring#3539
Closed
vidigoat wants to merge 1 commit into
Closed
docs: drop nonexistent 'context' param from RealtimeRunner.__init__ docstring#3539vidigoat wants to merge 1 commit into
vidigoat wants to merge 1 commit into
Conversation
… docstring RealtimeRunner.__init__ accepts only starting_agent, model, and config. The docstring's "context" entry is a copy-paste leftover from run(), which is the method that actually takes context. Drop the stale line so the Args block matches the signature. Signed-off-by: Vidit Patankar <vidit.patankar16@gmail.com>
Author
|
Closing this minor change to keep my contributions focused on substantive bug fixes. Thanks for your time! |
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.
Summary
RealtimeRunner.__init__only acceptsstarting_agent,model, andconfig:But its docstring's
Args:block also listscontext: The context to use for the session.— that parameter actually belongs to the separaterun()method below it (async def run(self, *, context=..., model_config=...)). It's a copy-paste leftover that documents a parameter__init__doesn't take.This drops the stale line so the
Args:block matches the signature. Docstring-only; no code or behavior change.Test plan
No runtime impact (comment-only). Module still parses; the documented args now exactly match
__init__'s signature.