Skip to content

[codex] consolidate docs and audio validation fixes - #2400

Merged
jxnl merged 2 commits into
mainfrom
codex/weekly-maintenance-2026-06-29
Jul 29, 2026
Merged

[codex] consolidate docs and audio validation fixes#2400
jxnl merged 2 commits into
mainfrom
codex/weekly-maintenance-2026-06-29

Conversation

@jxnl

@jxnl jxnl commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

Consolidates four compact, low-risk maintenance fixes from the open queue:

Superseded PRs / Issues

Validation

  • git diff --check
  • UV_CACHE_DIR=/private/tmp/uv-cache uv run pytest tests/v2/test_core_multimodal_runtime.py -q -> 23 passed
  • UV_CACHE_DIR=/private/tmp/uv-cache uv run ruff check instructor/v2/core/multimodal.py tests/v2/test_core_multimodal_runtime.py examples/crm/run.py
  • pre-commit on commit: Ruff check, Ruff format, uv.lock check skipped, dependency install/export hooks skipped, ty passed
  • targeted content check confirmed the old malformed docs link, duplicated CRM phrase, stale Gemini Flash-8b wording, and broken Vertex one-line call no longer appear in the touched docs/examples

Skipped Items

Skipped as too broad for this consolidation pass:

Draft Release Notes

  • Audio validation now raises explicit exceptions instead of relying on assert, so invalid audio inputs are rejected consistently even when Python runs with optimizations enabled.
  • Google provider docs now use the current generic mode names and clarify Union, Optional, streaming, and Vertex migration guidance.
  • Fixed two small docs/example quality issues: a broken semantic validation link and a duplicated word in the CRM example prompt.

Draft Tweet

small instructor cleanup this week

fixed audio validation so it does not depend on python asserts, cleaned up a few google docs lies, and patched a couple tiny docs papercuts

not flashy, but this is the kind of maintenance that keeps examples and error paths honest


Note

Low Risk
Runtime change is limited to clearer multimodal error paths (callers that relied on asserts under python -O now get exceptions); the rest is documentation and a trivial example string fix.

Overview
Bundles several small maintenance fixes: v2 Audio loading now matches Image/PDF by raising ValueError and FileNotFoundError (and rejecting empty files) instead of assert, with new runtime tests and an [Unreleased] changelog note.

Documentation updates correct Google/GenAI/Vertex guidance—generic Mode.TOOLS, legacy Mode.GENAI_* deprecation wording, Union vs Optional, streaming with Mode.JSON, trimmed Gemini limitations, fixed Vertex migration examples, and a broken semantic-validation blog link. patching.md drops stale provider-specific mode names. The CRM example prompt drops a duplicated word.

Reviewed by Cursor Bugbot for commit 15e9f4a. Configure here.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 29, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
instructor ba72f9d Commit Preview URL

Branch Preview URL
Jul 29 2026, 03:55 AM

@jxnl
jxnl marked this pull request as ready for review July 29, 2026 03:52
@jxnl
jxnl enabled auto-merge (squash) July 29, 2026 03:52
@jxnl
jxnl merged commit 3a315b8 into main Jul 29, 2026
33 of 34 checks passed
@jxnl
jxnl deleted the codex/weekly-maintenance-2026-06-29 branch July 29, 2026 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation (at least Google-related) is an outdated mess.

1 participant