Skip to content

docs: drop nonexistent 'context' param from RealtimeRunner.__init__ docstring#3539

Open
vidigoat wants to merge 1 commit into
openai:mainfrom
vidigoat:fix/realtime-runner-docstring
Open

docs: drop nonexistent 'context' param from RealtimeRunner.__init__ docstring#3539
vidigoat wants to merge 1 commit into
openai:mainfrom
vidigoat:fix/realtime-runner-docstring

Conversation

@vidigoat
Copy link
Copy Markdown

Summary

RealtimeRunner.__init__ only accepts starting_agent, model, and config:

def __init__(
    self,
    starting_agent: RealtimeAgent,
    *,
    model: RealtimeModel | None = None,
    config: RealtimeRunConfig | None = None,
) -> None:

But its docstring's Args: block also lists context: The context to use for the session. — that parameter actually belongs to the separate run() 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.

… 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant