From 0209231cab63ca5c2de3c6ffda27d42610f0619d Mon Sep 17 00:00:00 2001 From: Nick Kohrn Date: Thu, 4 Apr 2024 08:56:34 -0400 Subject: [PATCH] Edit documentation Edit documentation, based on feedback from @mergesort --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72c5bbb..866b4b1 100644 --- a/README.md +++ b/README.md @@ -216,7 +216,7 @@ static func shine(angle: Angle, duration: Double = 1.0) -> AnyChangeEffect Triggers a sound effect as feedback whenever a value changes. -This effect will not interrupt or duck any other audio that may currently playing. The sound effect may not be triggered, depending on the setting of the user's silent switch or playback device. +This effect will not interrupt or duck any other audio that may be currently playing. This effect is not guaranteed to be triggered; the effect running depends on the user's silent switch position and the current playback device. To relay important information to the user, you should always accompany audio effects with visual cues.