chuck icon indicating copy to clipboard operation
chuck copied to clipboard

Figure out how to deal with html in docstrings

Open nshaheed opened this issue 1 year ago • 0 comments

Gen17.help() in chuck spits out:

**************************
* Gen17 (unit generator) *
**************************
  |- Constructs a Chebyshev polynomial wavetable with harmonic partials of specified weights. The weight of partial n is specified by the nth element of the coefficients. Primarily used for waveshaping, driven by a SinOsc instead of a Phasor. See <a href="http://crca.ucsd.edu/~msp/techniques/v0.08/book-html/node74.html">http://crca.ucsd.edu/~msp/techniques/v0.08/book-html/node74.html</a> and <a href="http://en.wikipedia.org/wiki/Distortion_synthesis">http://en.wikipedia.org/wiki/Distortion_synthesis</a> for more information.
  |- (inheritance) Gen17 -> GenX -> UGen -> Object

Which having a link is great for ckdoc, but it's a bit jank when doing .help() in chuck itself. We should figure out some way to deal with this

nshaheed avatar May 15 '23 23:05 nshaheed