Skip to content

Commit

Permalink
Doc - Fix documentation for line and range opts
Browse files Browse the repository at this point in the history
  • Loading branch information
samaaron committed May 11, 2015
1 parent 2de7bd3 commit 8b3651e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions app/server/sonicpi/lib/sonicpi/spiderapi.rb
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,8 @@ def range(start, finish, *args)
summary: "Create a ring buffer with the specified start, finish and step size",
args: [[:start, :number], [:finish, :number], [:step_size, :number]],
returns: :ring,
opts: {:inclusive => "If set to true, range is inclusive of finish value"},
opts: {:step => "Size of increment between steps; tep size."
:inclusive => "If set to true, range is inclusive of finish value"},
accepts_block: false,
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",
examples: [
Expand Down Expand Up @@ -261,7 +262,7 @@ def line(start, finish, *args)
summary: "Create a ring buffer representing a straight line",
args: [[:start, :number], [:finish, :number]],
returns: :ring,
opts: {:slices => "number of slices or segments along the line",
opts: {:steps => "number of slices or segments along the line",
:inclusive => "boolean value representing whether or not to include finish value in line"},
accepts_block: false,
doc: "Create a ring buffer representing a straight line between start and finish of num_slices elements. Num slices defaults to `8`. Indexes wrap around positively and negatively. Similar to `range`.",
Expand Down

0 comments on commit 8b3651e

Please sign in to comment.