Skip to content

Docs: Fix typo in set_default_openai_key docstring #1834

@RaoHamzaTariq

Description

@RaoHamzaTariq

Issue

Image

In src/agents/__init__.py, the docstring for set_default_openai_key contains a typo:

Current:
"Set the default OpenAI API key to use for LLM requests (and optionally tracing()."

Problems:

  • Extra ) after tracing
  • Missing "for" before tracing

Suggested fix

It should read:
"Set the default OpenAI API key to use for LLM requests (and optionally for tracing)."

Why this matters

This typo appears in the generated API reference docs, which may confuse new users.
Fixing it improves clarity and professionalism of the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions