Skip to content

Consistently use "Python" in docstrings #1261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2025
Merged

Consistently use "Python" in docstrings #1261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/agents/function_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__`."""
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down