Skip to content

Commit

Permalink
Documentation: Fixing comment wrapping
Browse files Browse the repository at this point in the history
Limiting each line of comments to 80 characters so that they wrap properly.
  • Loading branch information
gregwht committed Feb 2, 2024
1 parent 6abd66b commit e1c0cdb
Showing 9 changed files with 26 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cmake.configureOnOpen": false
}
3 changes: 2 additions & 1 deletion docs/library/control/mousedown/example-0.py
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 4 additions & 1 deletion docs/library/control/mousedown/example-1.py
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion docs/library/control/mousex/example-0.py
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 4 additions & 1 deletion docs/library/control/mousex/example-1.py
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion docs/library/control/mousey/example-1.py
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion docs/library/envelope/line/example-0.py
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 3 additions & 1 deletion docs/library/sequencing/clockdivider/example-0.py
Original file line number Diff line number Diff line change
@@ -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)
3 changes: 2 additions & 1 deletion docs/library/sequencing/sequence/example-0.py
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit e1c0cdb

Please sign in to comment.