Skip to content

Commit b7d3a8e

Browse files
committed
improve docstrings
1 parent bfc2de7 commit b7d3a8e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/arduino/app_utils/audio.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ class SineGenerator:
1818
sample_rate (int): Audio sample rate in Hz.
1919
attack (float): Attack time for amplitude smoothing in seconds.
2020
release (float): Release time for amplitude smoothing in seconds.
21+
glide (float): Glide time for frequency smoothing in seconds.
2122
"""
2223

2324
def __init__(self, sample_rate: int):
@@ -97,6 +98,7 @@ def set_envelope_params(self, attack: float, release: float, glide: float) -> No
9798
amplitude when increasing amplitude).
9899
release (float): Release time in seconds (time to fall to target
99100
amplitude when decreasing amplitude).
101+
glide (float): Glide time in seconds (time to reach target frequency).
100102
"""
101103
self.attack = float(max(0.0, attack))
102104
self.release = float(max(0.0, release))

0 commit comments

Comments
 (0)