search

elemaudio / elementary

Elementary is a JavaScript library for digital audio signal processing.
https://www.elementary.audio/
MIT License
331 stars 29 forks source link

Incomplete documentation for WebRenderer.createRef() #51

Closed AvneeshSarwate closed 3 months ago

AvneeshSarwate commented 3 months ago

The documentation for createRef() does not show how/why/when to use the third parameter (children), neither in the guide nor the api doc

nick-thompson commented 3 months ago

Hey @AvneeshSarwate good catch, thanks for letting me know! There is this one line in the guide

let [svf, setFilterProps] = createNode("svf", {mode: 'lowpass'}, [filterInput]);

which I think was intended to demonstrate a case for using that children parameter, but it's quite buried. I'll update that api doc to be more clear

nick-thompson commented 3 months ago

I've just pushed a change to the website! Closing here, please reopen if the change feels insufficient. Thank you

AvneeshSarwate commented 3 months ago

excellent, appreciate the quick turnaround!