Edit documentation

Edit documentation, based on feedback from @mergesort
This commit is contained in:
Nick Kohrn 2024-04-04 08:56:34 -04:00 committed by GitHub
parent 290f70bf1d
commit 0209231cab
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

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