Skip to content

fix: correct RFC 3986 section reference in path_template docstring#3300

Open
aryanmotgi wants to merge 1 commit into
openai:mainfrom
aryanmotgi:fix/path-template-rfc-section
Open

fix: correct RFC 3986 section reference in path_template docstring#3300
aryanmotgi wants to merge 1 commit into
openai:mainfrom
aryanmotgi:fix/path-template-rfc-section

Conversation

@aryanmotgi
Copy link
Copy Markdown

What

The path_template docstring in src/openai/_utils/_path.py references "RFC 3986 §3.3" when describing the safe character set used for the query portion. The correct section for the query component is §3.4 — §3.3 is the Path component.

Evidence

src/openai/_utils/_path.py:92 (before):

Placeholders in the query portion are percent-encoded where the `query` set from
RFC 3986 §3.3 is considered safe except for = and & characters.

For comparison, the helper that actually does the query quoting documents itself correctly (src/openai/_utils/_path.py:32-33):

Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe.
https://datatracker.ietf.org/doc/html/rfc3986#section-3.4

RFC 3986 reference:

Fix

One-character docstring correction: §3.3 → §3.4. No behavior change.

@aryanmotgi aryanmotgi requested a review from a team as a code owner May 23, 2026 00:41
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