Skip to content

Commit 7e3c90e

Browse files
committed
Doc - fix indentation issues
If the start of a doc string line has enough whitespace the markdown converter will format it like code. Prevent this from happening in all the current docstrings. Fixes: #636
1 parent 98e8813 commit 7e3c90e

File tree

1 file changed

+6
-6
lines changed
  • app/server/sonicpi/lib/sonicpi/mods

1 file changed

+6
-6
lines changed

app/server/sonicpi/lib/sonicpi/mods/sound.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -970,9 +970,9 @@ def play(n, *args)
970970
summary: "Play current synth",
971971
doc: "Play note with current synth. Accepts a set of standard options which include control of an amplitude envelope with `attack:`, `decay:`, `sustain:` and `release:` phases. These phases are triggered in order, so the duration of the sound is attack + decay + sustain + release times. The duration of the sound does not affect any other notes. Code continues executing whilst the sound is playing through its envelope phases.
972972
973-
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See use_synth and with_synth for changing the current synth.
973+
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See `use_synth` and `with_synth` for changing the current synth.
974974
975-
If note is `nil`, `:r` or `:rest`, play is ignored and treated as a rest.
975+
If note is `nil`, `:r` or `:rest`, play is ignored and treated as a rest.
976976
",
977977
args: [[:note, :symbol_or_number]],
978978
opts: DEFAULT_PLAY_OPTS,
@@ -1027,9 +1027,9 @@ def play_pattern_timed(notes, times, *args)
10271027
summary: "Play pattern of notes with specific times",
10281028
doc: "Play each note in a list of notes one after another with specified times between them. The notes should be a list of MIDI numbers, symbols such as :E4 or chords such as chord(:A3, :major) - identical to the first parameter of the play function. The times should be a list of times between the notes in beats.
10291029
1030-
If the list of times is smaller than the number of gaps between notes, the list is repeated again. If the list of times is longer than the number of gaps between notes, then some of the times are ignored. See examples for more detail.
1030+
If the list of times is smaller than the number of gaps between notes, the list is repeated again. If the list of times is longer than the number of gaps between notes, then some of the times are ignored. See examples for more detail.
10311031
1032-
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See use_synth and with_synth for changing the current synth.",
1032+
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See `use_synth` and `with_synth` for changing the current synth.",
10331033
args: [[:notes, :list], [:times, :list_or_number]],
10341034
opts: DEFAULT_PLAY_OPTS,
10351035
accepts_block: false,
@@ -1101,7 +1101,7 @@ def play_chord(notes, *args)
11011101
summary: "Play notes simultaneously",
11021102
doc: "Play a list of notes at the same time.
11031103
1104-
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See use_synth and with_synth for changing the current synth.",
1104+
Accepts optional args for modification of the synth being played. See each synth's documentation for synth-specific opts. See `use_synth` and `with_synth` for changing the current synth.",
11051105
args: [[:notes, :list]],
11061106
opts: DEFAULT_PLAY_OPTS,
11071107
accepts_block: false,
@@ -1578,7 +1578,7 @@ def with_fx(fx_name, *args, &block)
15781578
summary: "Use Studio FX",
15791579
doc: "This applies the named effect (FX) to everything within a given `do`/`end` block. Effects may take extra parameters to modify their behaviour. See FX help for parameter details.
15801580
1581-
For advanced control, it is also possible to modify the parameters of an effect within the body of the block. If you define the block with a single argument, the argument becomes a reference to the current effect and can be used to control its parameters (see examples).",
1581+
For advanced control, it is also possible to modify the parameters of an effect within the body of the block. If you define the block with a single argument, the argument becomes a reference to the current effect and can be used to control its parameters (see examples).",
15821582
args: [[:fx_name, :symbol]],
15831583
opts: {reps: "Number of times to repeat the block in an iteration.",
15841584
kill_delay: "Amount of time to wait after all synths triggered by the block have completed before stopping and freeing the effect synthesiser." },

0 commit comments

Comments
 (0)