Repository navigation
Python: Fix the serialization protocol round-trip example - #9106
BlueRaddish wants to merge 2 commits into
Conversation
Co-authored-by: OpenAI Codex <noreply@openai.com>
|
BlueRaddish please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
|
/review |
There was a problem hiding this comment.
MAF Automated Review — Iteration 1
Result: No findings
Scope: full PR (1 commit(s)): 48459506b3f5
Model: gpt-5.6-sol
Overview
This documentation-only change replaces an invalid UsageDetails example with a standalone Content serialization round trip. Content provides the documented constructors and serialization methods, is exported from the package root, and its text round-trip behavior is covered by existing tests. No runtime, compatibility, architectural, or security risk was established.
Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
No publishable findings remained after source verification for this scope.
Motivation & Context
The
SerializationProtocoldocumentation callsUsageDetails.to_dict()andUsageDetails.from_dict(), butUsageDetailsis now a TypedDict and creates a plain dictionary. Copying that example raisesAttributeError.Description & Review Guide
Contentfor the serialization/round-trip examples and explicitly import the protocol so the second block runs on its own.Contentillustrates the existing serialization protocol accurately.Validation: executed both protocol docstring examples directly from the edited source against the editable core package. The original second block failed with
'dict' object has no attribute 'to_dict'; both now pass. Ruff andgit diff --checkpassed. No model calls were needed.Related Issue
Small documentation correction, following CONTRIBUTING's exception for trivial changes. Fresh upstream code and open-PR searches still showed the broken example and no overlapping correction.
Contribution Checklist
The full build and unit suite were not run for this docstring-only correction. The focused checks above passed. No issue is linked under CONTRIBUTING's exception for trivial corrections.
AI assistance: OpenAI Codex prepared and validated the correction.