Skip to content

Conversation

HafizFasih
Copy link
Contributor

@HafizFasih HafizFasih commented Jul 3, 2025

Describe the bug
A clear and concise description of what the bug is.

In the function_schema method of the OpenAI Agents SDK, the following line:

description=description_override or doc_info.description if doc_info else None

does not honor description_override when use_docstring_info=False. This happens because of operator precedence in Python. Without parentheses, the expression is interpreted as:

description=(description_override or doc_info.description) if doc_info else None

So when doc_info is None, even if description_override is set, it falls back to None

Debug information
Python version (e.g. Python 3.10)
Repro steps

from agents.function_schema import function_schema

def my_func():
    pass

schema = function_schema(
    my_func,
    description_override ="CustomDescription",
    use_docstring_info=False
)

print(schema.description) # Expected: "CustomDescription", Actual: None

Expected behavior

Even when use_docstring_info=False, if description_override is provided, it should be used for description.

Suggested Fix:
Update this line:
description=description_override or doc_info.description if doc_info else None
To this (with parentheses to enforce correct evaluation):
description=description_override or (doc_info.description if doc_info else None)

@HafizFasih HafizFasih changed the title fix(function_schema): list comprehension issue fix(function_schema): description issue Jul 3, 2025
@seratch seratch added bug Something isn't working feature:core labels Jul 8, 2025
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@seratch seratch changed the title fix(function_schema): description issue description_override is not properly used for function_schema.description Jul 8, 2025
@rm-openai rm-openai merged commit e251fa6 into openai:main Jul 8, 2025
5 checks passed
@Aqsagull99
Copy link

well_done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working feature:core
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants