Skip to content

Commit a595636

Browse files
authored
Fix Softcut argument name for docs (#1235)
1 parent ecc3c16 commit a595636

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

doc/modules/softcut.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h2><a href="#"> </a></h2>
110110
<td class="summary">set pan position of each voice.</td>
111111
</tr>
112112
<tr>
113-
<td class="name" nowrap><a href="#level_input_cut">level_input_cut (ch, voice, pos)</a></td>
113+
<td class="name" nowrap><a href="#level_input_cut">level_input_cut (ch, voice, amp)</a></td>
114114
<td class="summary">set input level to each voice/channel.</td>
115115
</tr>
116116
<tr>
@@ -407,7 +407,7 @@ <h3>Parameters:</h3>
407407
</dd>
408408
<dt>
409409
<a name = "level_input_cut"></a>
410-
<strong>level_input_cut (ch, voice, pos)</strong>
410+
<strong>level_input_cut (ch, voice, amp)</strong>
411411
</dt>
412412
<dd>
413413
set input level to each voice/channel.
@@ -423,9 +423,9 @@ <h3>Parameters:</h3>
423423
<span class="types"><span class="type">int</span></span>
424424
: voice index
425425
</li>
426-
<li><span class="parameter">pos</span>
426+
<li><span class="parameter">amp</span>
427427
<span class="types"><span class="type">number</span></span>
428-
: position in [-1, 1]
428+
: linear amplitude
429429
</li>
430430
</ul>
431431

@@ -1599,7 +1599,7 @@ <h3>Parameters:</h3>
15991599
<h3>Parameters:</h3>
16001600
<ul>
16011601
<li><span class="parameter">file</span>
1602-
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
1602+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
16031603
: input file path
16041604
</li>
16051605
<li><span class="parameter">start_src</span>
@@ -1640,7 +1640,7 @@ <h3>Parameters:</h3>
16401640
<h3>Parameters:</h3>
16411641
<ul>
16421642
<li><span class="parameter">file</span>
1643-
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
1643+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
16441644
: input file path
16451645
</li>
16461646
<li><span class="parameter">start_src</span>
@@ -1673,7 +1673,7 @@ <h3>Parameters:</h3>
16731673
<h3>Parameters:</h3>
16741674
<ul>
16751675
<li><span class="parameter">file</span>
1676-
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
1676+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
16771677
: output file path
16781678
</li>
16791679
<li><span class="parameter">start</span>
@@ -1706,7 +1706,7 @@ <h3>Parameters:</h3>
17061706
<h3>Parameters:</h3>
17071707
<ul>
17081708
<li><span class="parameter">file</span>
1709-
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
1709+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
17101710
: output file path
17111711
</li>
17121712
<li><span class="parameter">start</span>
@@ -1831,7 +1831,7 @@ <h3>Parameters:</h3>
18311831
<h3>Returns:</h3>
18321832
<ol>
18331833

1834-
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
1834+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
18351835
table of parameter states for each voice
18361836
</ol>
18371837

@@ -1867,7 +1867,7 @@ <h3>Returns:</h3>
18671867
</div> <!-- id="main" -->
18681868
<div id="about">
18691869
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
1870-
<i style="float:right;">Last updated 2020-10-20 12:49:33 </i>
1870+
<i style="float:right;">Last updated 2020-11-15 03:28:56 </i>
18711871
</div> <!-- id="about" -->
18721872
</div> <!-- id="container" -->
18731873
</body>

lua/core/softcut.lua

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ end
4343
--- set input level to each voice/channel.
4444
-- @tparam int ch : ADC channel index
4545
-- @tparam int voice : voice index
46-
-- @tparam number pos : position in [-1, 1]
47-
SC.level_input_cut = function(ch, voice, pos)
48-
_norns.level_input_cut(ch, voice, pos)
46+
-- @tparam number amp : linear amplitude
47+
SC.level_input_cut = function(ch, voice, amp)
48+
_norns.level_input_cut(ch, voice, amp)
4949
end
5050

5151
--- set mix matrix, voice output to voice input.

0 commit comments

Comments
 (0)