docs and examples: fix stale openai.OpenAI reference, a verb typo, and poetry shebangs - #3821
Open
simpleqt wants to merge 1 commit into
Open
docs and examples: fix stale openai.OpenAI reference, a verb typo, and poetry shebangs#3821simpleqt wants to merge 1 commit into
simpleqt wants to merge 1 commit into
Conversation
…d poetry shebangs - helpers.md's second streaming snippet used client = openai.OpenAI() without importing the module (copied from the earlier snippet) - _pydantic.py: 'Expected $ref ... to resolved' → 'to resolve' - 4 example shebangs still said 'poetry run python'; CONTRIBUTING.md prescribes 'uv run python' (26/30 examples already use it)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three small hand-written fixes (all outside the generator's scope —
helpers.md,src/openai/lib/,examples/):helpers.mdstreaming snippet:client = openai.OpenAI()raisedNameErroras written — the block importsOpenAIdirectly (copied from the earlier snippet whereimport openaiexists)src/openai/lib/_pydantic.py:ValueErrormessage "Expected: {ref}to resolved to a dictionary" → "to resolve"examples/{demo,async_demo,streaming,video}.py: shebangs still#!/usr/bin/env -S poetry run pythonwhile CONTRIBUTING.md prescribesuv run python(26/30 examples already migrated); the documented./examples/<script>.pyinvocation failed without poetry installed