Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Figure out how to deal with html in docstrings #300

Open
nshaheed opened this issue May 15, 2023 · 0 comments
Open

Figure out how to deal with html in docstrings #300

nshaheed opened this issue May 15, 2023 · 0 comments

Comments

@nshaheed
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant