Skip to content

Commit

Permalink
Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Feb 2, 2024
1 parent d9e2e57 commit 2f1d7da
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 8 deletions.
8 changes: 6 additions & 2 deletions docs/library/control/mousedown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Outputs 1 if the left mouse button is down, 0 otherwise. Currently only supporte
```python

#-------------------------------------------------------------------------------
# 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)
Expand All @@ -28,7 +29,10 @@ osc.play()
```python

#-------------------------------------------------------------------------------
# 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
Expand Down
8 changes: 6 additions & 2 deletions docs/library/control/mousex/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Outputs the normalised cursor X position, from 0 to 1. Currently only supported
```python

#-------------------------------------------------------------------------------
# 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)
Expand All @@ -28,7 +29,10 @@ osc.play()
```python

#-------------------------------------------------------------------------------
# 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
Expand Down
5 changes: 4 additions & 1 deletion docs/library/control/mousey/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ osc.play()
```python

#-------------------------------------------------------------------------------
# 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
Expand Down
3 changes: 2 additions & 1 deletion docs/library/envelope/line/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Line segment with the given start/end values and duration. If loop is true, repe
```python

#-------------------------------------------------------------------------------
# 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)
Expand Down
4 changes: 3 additions & 1 deletion docs/library/sequencing/clockdivider/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ When given a `clock` input (e.g., an Impulse), divides the clock by the given `f
```python

#-------------------------------------------------------------------------------
# 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)
Expand Down
3 changes: 2 additions & 1 deletion docs/library/sequencing/sequence/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Outputs the elements in `sequence`, incrementing position on each `clock`.
```python

#-------------------------------------------------------------------------------
# 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)
Expand Down

0 comments on commit 2f1d7da

Please sign in to comment.