Documentation: Updating SawLFO

Updating index.md and adding example-0.py
ideoforms · Dec 5, 2023 · fef0014 · fef0014
1 parent 4625381
commit fef0014
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/docs/library/oscillators/sawlfo/example-0.py b/docs/library/oscillators/sawlfo/example-0.py
@@ -0,0 +1,8 @@
+from signalflow import *
+graph = AudioGraph()
+
+# Siren effect, using a sawtooth LFO to modulate a sinewave's frequency
+lfo = SawLFO(1, 200, 1000)
+sine = SineOscillator(lfo)
+sine.play()
+graph.wait()
diff --git a/docs/library/oscillators/sawlfo/index.md b/docs/library/oscillators/sawlfo/index.md
@@ -1,5 +1,5 @@
 title: SawLFO node documentation
-description: SawLFO: Produces a sawtooth LFO, with output ranging from `min` to `max`.
+description: SawLFO: Produces a sawtooth LFO at the given `frequency` and `phase` offset, with output ranging from `min` to `max`.
 
 [Reference library](../../index.md) > [Oscillators](../index.md) > [SawLFO](index.md)
 
@@ -9,5 +9,14 @@ description: SawLFO: Produces a sawtooth LFO, with output ranging from `min` to
 SawLFO(frequency=1.0, min=0.0, max=1.0, phase=0.0)
 ```
 
-Produces a sawtooth LFO, with output ranging from `min` to `max`.
+Produces a sawtooth LFO at the given `frequency` and `phase` offset, with output ranging from `min` to `max`.
 
+### Examples
+
+```python
+
+# Siren effect, using a sawtooth LFO to modulate a sinewave's frequency
+lfo = SawLFO(1, 200, 1000)
+sine = SineOscillator(lfo)
+sine.play()
+```