Skip to content

Commit dfbb053

Browse files
committed
Improve documentation.
1 parent 078a680 commit dfbb053

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

spats.lib

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,9 @@ with {
188188
// * `xref`: x-coordinate of the reference listening point in meters
189189
// * `yref`: y-coordinate of the reference listening point in meters
190190
// * `zref`: z-coordinate of the reference listening point in meters
191-
// * `speakersDist`: distance between speakers in meters
192-
// * `nSources`: number of sound sources
193-
// * `nSpeakers`: number of speakers
191+
// * `speakersDist`: distance between speakers in meters (a constant numerical expression)
192+
// * `nSources`: number of sound sources (a constant numerical expression)
193+
// * `nSpeakers`: number of speakers (a constant numerical expression)
194194
// * `inProc`: per-source processor function, as a function of the source index
195195
// * `xs`: x-coordinate of the sound source in meters, as a function of the source index
196196
// * `ys`: y-coordinate of the sound source in meters, as a function of the source index
@@ -252,7 +252,7 @@ with {
252252
// #### Usage
253253
//
254254
// ```
255-
// wfs_ui(xref, yref, zref, speakersDist, nSources, nSpeaker) : si.bus(nSpeakers)
255+
// wfs_ui(xref, yref, zref, speakersDist, nSources, nSpeakers) : si.bus(nSpeakers)
256256
// ```
257257
//
258258
// Where:
@@ -261,8 +261,8 @@ with {
261261
// * `yref`: y-coordinate of the reference listening point in meters
262262
// * `zref`: z-coordinate of the reference listening point in meters
263263
// * `speakersDist`: distance between speakers in meters
264-
// * `nSources`: number of sound sources
265-
// * `nSpeakers`: number of speakers
264+
// * `nSources`: number of sound sources (a constant numerical expression)
265+
// * `nSpeakers`: number of speakers (a constant numerical expression)
266266
//
267267
// #### Test
268268
// ```

0 commit comments

Comments
 (0)