From b3d7d4dd1d5cfe9bc4a1f79e869231e0123677a7 Mon Sep 17 00:00:00 2001 From: MUHAMMAD SALMAN HUSSAIN <160324527+mshsheikh@users.noreply.github.com> Date: Sat, 26 Jul 2025 09:59:07 +0500 Subject: [PATCH] Improve documentation terminology and capitalization Capitalized "Python" as it's a proper noun in function documentation. Changed "providing" to "producing" for more accurate technical description of LLM behavior. These minor documentation improvements enhance professionalism and technical accuracy while maintaining identical functionality. --- src/agents/function_schema.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/agents/function_schema.py b/src/agents/function_schema.py index ec54d8227..d0b4a360f 100644 --- a/src/agents/function_schema.py +++ b/src/agents/function_schema.py @@ -76,7 +76,7 @@ def to_call_args(self, data: BaseModel) -> tuple[list[Any], dict[str, Any]]: @dataclass class FuncDocumentation: - """Contains metadata about a python function, extracted from its docstring.""" + """Contains metadata about a Python function, extracted from its docstring.""" name: str """The name of the function, via `__name__`.""" @@ -194,7 +194,7 @@ def function_schema( strict_json_schema: bool = True, ) -> FuncSchema: """ - Given a python function, extracts a `FuncSchema` from it, capturing the name, description, + Given a Python function, extracts a `FuncSchema` from it, capturing the name, description, parameter descriptions, and other metadata. Args: @@ -208,7 +208,7 @@ def function_schema( descriptions. strict_json_schema: Whether the JSON schema is in strict mode. If True, we'll ensure that the schema adheres to the "strict" standard the OpenAI API expects. We **strongly** - recommend setting this to True, as it increases the likelihood of the LLM providing + recommend setting this to True, as it increases the likelihood of the LLM producing correct JSON input. Returns: