Merge pull request #112 from ideoforms/docs/examples

Documentation: Fixing comment wrapping

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "cmake.configureOnOpen": false
+}

docs/library/control/mousedown/example-0.py

@@ -2,7 +2,8 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# When the left mouse button is clicked, as detected by MouseDown(), an LFO is applied to the oscillator's frequency.
+# When the left mouse button is clicked, as detected by MouseDown(), an LFO is 
+# applied to the oscillator's frequency.
 #-------------------------------------------------------------------------------
 lfo = SineLFO(5, 100, 600)
 frequency = If(MouseDown(), lfo, 100)

docs/library/control/mousedown/example-1.py

@@ -2,7 +2,10 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# A simple wobbling synthesiser controlled using the mouse. When the mouse is clicked, as detected by MouseDown(), an LFO is activated and affects the oscillator's frequency. MouseX position changes the rate of the LFO. MouseY position changes the upper frequency limit, affecting pitch.
+# A simple wobbling synthesiser controlled using the mouse. When the mouse is 
+# clicked, as detected by MouseDown(), an LFO is activated and affects the 
+# oscillator's frequency. MouseX position changes the rate of the LFO. MouseY 
+# position changes the upper frequency limit, affecting pitch.
 #-------------------------------------------------------------------------------
 rate = MouseX() * 10
 upper_limit = MouseY() * 1500

docs/library/control/mousex/example-0.py

@@ -2,7 +2,8 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# Using the MouseX position to change the rate of an LFO, which is modulating an oscillator's frequency
+# Using the MouseX position to change the rate of an LFO, which is modulating an
+# oscillator's frequency.
 #-------------------------------------------------------------------------------
 lfo_rate = MouseX() * 10
 frequency = SineLFO(lfo_rate, 100, 600)

docs/library/control/mousex/example-1.py

@@ -2,7 +2,10 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# A simple wobbling synthesiser controlled using the mouse. When the mouse is clicked, as detected by MouseDown(), an LFO is activated and affects the oscillator's frequency. MouseX position changes the rate of the LFO. MouseY position changes the upper frequency limit, affecting pitch.
+# A simple wobbling synthesiser controlled using the mouse. When the mouse is 
+# clicked, as detected by MouseDown(), an LFO is activated and affects the 
+# oscillator's frequency. MouseX position changes the rate of the LFO. MouseY 
+# position changes the upper frequency limit, affecting pitch.
 #-------------------------------------------------------------------------------
 rate = MouseX() * 10
 upper_limit = MouseY() * 1500

docs/library/control/mousey/example-1.py

@@ -2,7 +2,10 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# A simple wobbling synthesiser controlled using the mouse. When the mouse is clicked, as detected by MouseDown(), an LFO is activated and affects the oscillator's frequency. MouseX position changes the rate of the LFO. MouseY position changes the upper frequency limit, affecting pitch.
+# A simple wobbling synthesiser controlled using the mouse. When the mouse is 
+# clicked, as detected by MouseDown(), an LFO is activated and affects the 
+# oscillator's frequency. MouseX position changes the rate of the LFO. MouseY 
+# position changes the upper frequency limit, affecting pitch.
 #-------------------------------------------------------------------------------
 rate = MouseX() * 10
 upper_limit = MouseY() * 1500

docs/library/envelope/line/example-0.py

@@ -2,7 +2,8 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# Using a line to control the gain of an oscillator, emulating a sidechain ducking effect.
+# Using a line to control the gain of an oscillator, emulating a sidechain 
+# ducking effect.
 #-------------------------------------------------------------------------------
 clock = Impulse(frequency=1.0)
 line = Line(0.0, 0.5, 0.5, False, clock)

docs/library/sequencing/clockdivider/example-0.py

@@ -2,7 +2,9 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# Using a ClockDivider to create rhythms related to the main clock. Here the oscillator in the left channel is heard on every tick of the clock. The oscillator in the right channel is heard every 3 ticks of the clock.
+# Using a ClockDivider to create rhythms related to the main clock. Here the 
+# oscillator panned left is heard on every tick of the clock. The oscillator 
+# panned right is heard every 3 ticks of the clock.
 #-------------------------------------------------------------------------------
 clock = Impulse(2.0)
 divided_clock = ClockDivider(clock, 3)

docs/library/sequencing/sequence/example-0.py

@@ -2,7 +2,8 @@
 graph = AudioGraph()
 
 #-------------------------------------------------------------------------------
-# Creating a sequence using the MIDI note values of a C Major scale, starting on middle C.
+# Creating a sequence using the MIDI note values of a C Major scale, starting on
+# middle C.
 #-------------------------------------------------------------------------------
 clock = Impulse(2.0)
 sequence = Sequence([ 60, 62, 64, 65, 67, 69, 71, 72 ], clock)