From 2f1d7da1bdbbb900980fc65845083f9a60d8cdcd Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Fri, 2 Feb 2024 12:47:18 +0000 Subject: [PATCH] Regenerate docs --- docs/library/control/mousedown/index.md | 8 ++++++-- docs/library/control/mousex/index.md | 8 ++++++-- docs/library/control/mousey/index.md | 5 ++++- docs/library/envelope/line/index.md | 3 ++- docs/library/sequencing/clockdivider/index.md | 4 +++- docs/library/sequencing/sequence/index.md | 3 ++- 6 files changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/library/control/mousedown/index.md b/docs/library/control/mousedown/index.md index 976eb4eb..5386c641 100644 --- a/docs/library/control/mousedown/index.md +++ b/docs/library/control/mousedown/index.md @@ -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) @@ -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 diff --git a/docs/library/control/mousex/index.md b/docs/library/control/mousex/index.md index e3586430..131d02bf 100644 --- a/docs/library/control/mousex/index.md +++ b/docs/library/control/mousex/index.md @@ -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) @@ -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 diff --git a/docs/library/control/mousey/index.md b/docs/library/control/mousey/index.md index 57e155b1..16f0ecb9 100644 --- a/docs/library/control/mousey/index.md +++ b/docs/library/control/mousey/index.md @@ -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 diff --git a/docs/library/envelope/line/index.md b/docs/library/envelope/line/index.md index dd36537e..40d0235d 100644 --- a/docs/library/envelope/line/index.md +++ b/docs/library/envelope/line/index.md @@ -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) diff --git a/docs/library/sequencing/clockdivider/index.md b/docs/library/sequencing/clockdivider/index.md index 87c65c6c..09011287 100644 --- a/docs/library/sequencing/clockdivider/index.md +++ b/docs/library/sequencing/clockdivider/index.md @@ -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) diff --git a/docs/library/sequencing/sequence/index.md b/docs/library/sequencing/sequence/index.md index b885be47..5031a3cb 100644 --- a/docs/library/sequencing/sequence/index.md +++ b/docs/library/sequencing/sequence/index.md @@ -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)