Skip to content

Commit 882e19f

Browse files
committed
update docstrings
1 parent d0491c7 commit 882e19f

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

app/server/sonicpi/lib/sonicpi/spiderapi.rb

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ def bools(*args)
3131
end
3232
end.ring
3333
end
34+
doc name: :bools,
35+
introduced: Version.new(2,2,0),
36+
summary: "Create a ring of boolean values",
37+
args: [[:list, :array]],
38+
opts: nil,
39+
accepts_block: false,
40+
doc: "Create a new ring of booleans values from 1s, and 0s which can be easier to write and manipulate in a live setting.",
41+
examples: [
42+
"(bools 1, 0) #=> (ring true, false)",
43+
"(bools 1, 0, true, false, nil) #=> (ring true, false, true, false, false)"
44+
]
3445

3546
def knit(*args)
3647
res = []
@@ -49,8 +60,8 @@ def knit(*args)
4960
accepts_block: false,
5061
doc: "Knits a series of value, count pairs to create a ring buffer where each value is repeated count times.",
5162
examples: [
52-
"(knit 1, 5) #=> [1, 1, 1, 1, 1]",
53-
"(knit :e2, 2, :c2, 3) #=> [:e2, :e2, :c2, :c2, :c2]"
63+
"(knit 1, 5) #=> (ring 1, 1, 1, 1, 1)",
64+
"(knit :e2, 2, :c2, 3) #=> (ring :e2, :e2, :c2, :c2, :c2)"
5465
]
5566

5667
def range(start, finish, step_size=1)
@@ -64,10 +75,10 @@ def range(start, finish, step_size=1)
6475
accepts_block: false,
6576
doc: "Create a new ring buffer from the range arguments (start, finish and step size). Step size defaults to 1. Indexes wrap around positively and negatively",
6677
examples: [
67-
"(range 1, 5) #=> [1, 2, 3, 4, 5]",
68-
"(range 1, 5, 1) #=> [1, 2, 3, 4, 5]",
69-
"(range 1, 5, 2) #=> [1, 3, 5]",
70-
"(range 1, -5, -2) #=> [1, -1, -3, -5]",
78+
"(range 1, 5) #=> (ring 1, 2, 3, 4, 5)",
79+
"(range 1, 5, 1) #=> (ring 1, 2, 3, 4, 5)",
80+
"(range 1, 5, 2) #=> (ring 1, 3, 5)",
81+
"(range 1, -5, -2) #=> (ring 1, -1, -3, -5)",
7182
"(range 1, -5, -2)[-1] #=> -5"
7283
]
7384

@@ -728,7 +739,7 @@ def use_random_seed(seed, &block)
728739
end
729740
doc name: :use_random_seed,
730741
introduced: Version.new(2,0,0),
731-
summmary: "Set random seed generator to known seed",
742+
summary: "Set random seed generator to known seed",
732743
doc: "Resets the random number generator to the specified seed. All subsequently generated random numbers will use this new generator and the current generator is discarded. Use this to change the sequence of random numbers in your piece in a way that can be reproduced",
733744
args: [[:seed, :number]],
734745
opts: nil,

0 commit comments

Comments
 (0)