fix: play_audio docstring wait timeout says 15s, actual default is 30s#477
Conversation
The wait timeout docstring for OVOSSkill.play_audio said blocking waits 15 seconds by default, but the code's actual default (`timeout = 30 if isinstance(wait, bool) else wait`) is 30 seconds. Checked sibling audio methods (speak, speak_dialog) - their 15s docstrings match their actual 15s defaults, so only play_audio had the copy-paste mismatch. No runtime behavior changed, docstring only. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 52 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
A new update is available for your PR checks! 📥I've aggregated the results of the automated checks for this PR below. 🔍 LintChecking if we've met all our check criteria. ✅ ❌ ruff: issues found — see job log ⚖️ License CheckI've audited the copyright holders list. 👥 ✅ No license violations found. Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed. 🔒 Security (pip-audit)Scanning the horizon for any zero-day threats. 🌅 ✅ No known vulnerabilities found (73 packages scanned). 📋 Repo HealthEnsuring the repo is staying active (aka commit frequency). 🏃♂️ ✅ All required files present. Latest Version: ✅ 🔨 Build TestsThe build is fresh out of the oven! 🥯 ✅ All versions pass
The automation never sleeps, but I might reboot. 💤 |
What was broken
OVOSSkill.play_audio's docstring for thewaitparameter said blocking would wait "15 seconds" by default:But the actual code uses a 30-second default:
So a developer reading the docstring and calling
play_audio(path, wait=True)would expect a 15s block, while the real behavior blocks for 30s.How it fails
Purely a documentation/discoverability issue — no crash or exception. Anyone relying on the docstring's stated timeout to reason about skill responsiveness or write timing-sensitive code would be misled.
The fix
Updated the docstring to say 30 seconds, matching the actual default. No runtime behavior was changed.
Checked sibling audio-related methods (
speak,speak_dialog) for the same copy-paste mismatch — their docstrings say 15 seconds and their code (timeout = 15 if isinstance(wait, bool) else wait) actually defaults to 15 seconds, so those are correct and were left untouched.Verification
Ran the nearest test module (docs-only change, so just confirming nothing broke):
Note: this is unrelated to draft PR #476 (also a docstring-only fix, for
default_shutdown).This PR was authored with AI assistance (Claude).