docs: clean up changelog release notes#696
Conversation
jbeckwith-oai
left a comment
There was a problem hiding this comment.
Thanks for cleaning this up. I verified that the two 3.24.0 sections are duplicates and that the surviving section still contains the complete Features, Bug Fixes, and Chores content. Removing the duplicate is correct, and because release-please prepends new entries, this historical cleanup should persist.
The PR is docs-only and not functionally necessary, but it is worthwhile for changelog accuracy. I am requesting changes because both edited release-note sentences remain misleading after the spelling corrections. The inline suggestions below use the actual Go API changes and exported type names.
No automated tests are needed for this patch; the diff is whitespace-clean and applies cleanly to current main.
| ### ⚠ BREAKING CHANGES | ||
|
|
||
| * **api:** The `voice` param and resouce has changed from a `string` to a `string | {id: string}`. This is a breaking change for Go. | ||
| * **api:** The `voice` param and resource has changed from a `string` to a `string | {id: string}`. This is a breaking change for Go. |
There was a problem hiding this comment.
The spelling change fixes resouce, but the resulting sentence—“the voice param and resource has changed”—is still grammatically awkward and does not clearly describe the breaking change.
I checked the underlying custom-voices change: the Go request fields changed from string alias types to union parameter types that also accept {id: string} objects. Please describe that directly. Suggested wording:
The
voiceparameter type has changed from astringto astring | {id: string}. This is a breaking change for Go.
| ### Features | ||
|
|
||
| * **api:** The GA ComputerTool now uses the CompuerTool class. The 'computer_use_preview' tool is moved to ComputerUsePreview ([347418b](https://github.com/openai/openai-go/commit/347418be8d4fa33881d9ac30f6c7132f2f545f2b)) | ||
| * **api:** The GA ComputerTool now uses the ComputerTool class. The 'computer_use_preview' tool is moved to ComputerUsePreview ([347418b](https://github.com/openai/openai-go/commit/347418be8d4fa33881d9ac30f6c7132f2f545f2b)) |
There was a problem hiding this comment.
This sentence still does not use the actual Go terminology or exported identifiers. Go has types, not classes, and the preview type is exported as ComputerUsePreviewTool (with ComputerUsePreviewToolParam for requests), not ComputerUsePreview.
It is also clearer to distinguish the wire-level tool name from the Go type. Suggested wording:
The GA
computertool now uses theComputerTooltype. Thecomputer_use_previewtool has moved toComputerUsePreviewTool.
|
Thank you, I have pushed the fix in 19b4d5f |
Why
The changelog contains a duplicated 3.24.0 release section and two inaccurate recent release-note descriptions. The cleanup keeps the release history accurate and uses the actual Go API terminology.
What changed
Validation