Correct sp.wfs docuemntation.

grame-cncm · Feb 25, 2025 · 15163e7 · 15163e7
1 parent 013d096
commit 15163e7
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 4 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -389,5 +389,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2025-02-25 13:41:20.579872+00:00
+Build Date UTC : 2025-02-25 16:35:30.743751+00:00
 -->
diff --git a/docs/libs/spats/index.html b/docs/libs/spats/index.html
@@ -318,7 +318,7 @@ <h4 id="usage_3">Usage</h4>
 <li><code>speakersDist</code>: distance between speakers</li>
 <li><code>nSources</code>: number of sound sources</li>
 <li><code>nSpeakers</code>: number of speakers</li>
-<li><code>inGain</code>: input gain (0-1)</li>
+<li><code>inGain</code>: input gain (0-1) as a function of the source index</li>
 <li><code>xs</code>: x-coordinate of the sound source as a function of the source index</li>
 <li><code>ys</code>: y-coordinate of the sound source as a function of the source index</li>
 <li><code>zs</code>: z-coordinate of the sound source as a function of the source index</li>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/spats.lib b/spats.lib
@@ -136,7 +136,7 @@ with {
 // * `speakersDist`: distance between speakers
 // * `nSources`: number of sound sources
 // * `nSpeakers`: number of speakers
-// * `inGain`: input gain (0-1)
+// * `inGain`: input gain (0-1) as a function of the source index
 // * `xs`: x-coordinate of the sound source as a function of the source index
 // * `ys`: y-coordinate of the sound source as a function of the source index
 // * `zs`: z-coordinate of the sound source as a function of the source index