Skip to content

fix: play_audio docstring wait timeout says 15s, actual default is 30s#477

Merged
JarbasAl merged 1 commit into
devfrom
fix/play-audio-docstring
Jul 23, 2026
Merged

fix: play_audio docstring wait timeout says 15s, actual default is 30s#477
JarbasAl merged 1 commit into
devfrom
fix/play-audio-docstring

Conversation

@JarbasAl

Copy link
Copy Markdown
Member

What was broken

OVOSSkill.play_audio's docstring for the wait parameter said blocking would wait "15 seconds" by default:

@param wait: set to True to block while the audio
             is being played for 15 seconds. Alternatively, set
             to an integer to specify a timeout in seconds.

But the actual code uses a 30-second default:

if wait:
    timeout = 30 if isinstance(wait, bool) else wait

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):

pytest test/unittests/skills/test_ovos.py
14 passed

Note: this is unrelated to draft PR #476 (also a docstring-only fix, for default_shutdown).

This PR was authored with AI assistance (Claude).

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>
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@JarbasAl, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9bdfad39-03c2-4a02-b1e9-85b1ef4842b8

📥 Commits

Reviewing files that changed from the base of the PR and between 63ab523 and 9891b83.

📒 Files selected for processing (1)
  • ovos_workshop/skills/ovos.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/play-audio-docstring

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the fix label Jul 23, 2026
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

A new update is available for your PR checks! 📥

I've aggregated the results of the automated checks for this PR below.

🔍 Lint

Checking if we've met all our check criteria. ✅

ruff: issues found — see job log

⚖️ License Check

I'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 Health

Ensuring the repo is staying active (aka commit frequency). 🏃‍♂️

✅ All required files present.

Latest Version: 9.2.4a1

ovos_workshop/version.py — Version file
README.md — README
LICENSE — License file
pyproject.toml — pyproject.toml
⚠️ setup.py — setup.py
CHANGELOG.md — Changelog
ovos_workshop/version.py has valid version block markers

🔨 Build Tests

The build is fresh out of the oven! 🥯

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

The automation never sleeps, but I might reboot. 💤

@JarbasAl
JarbasAl marked this pull request as ready for review July 23, 2026 18:36
@JarbasAl
JarbasAl merged commit b234cc5 into dev Jul 23, 2026
12 checks passed
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.

1 participant