byulparan / cl-collider

A SuperCollider client for CommonLisp
Other
218 stars 23 forks source link

Add docstrings for UGens #91

Closed ntrocado closed 3 years ago

ntrocado commented 3 years ago

This sets the docstrings of the functions corresponding to the various UGens, according to their description on the helpfiles installed together with SuperCollider (if one such file exists).

The helpfiles come written in SCDoc Syntax. Most features are ignored, other than finding the appropriate section and removing markup tags.

I only tested the code to find the correct documentation directory in Windows. It should also work in MacOS and Linux... testing on these systems would be appreciated!

defaultxr commented 3 years ago

It seems to work on Linux. Very cool!

justin2004 commented 3 years ago

i never have sc-plugin-paths bound. which it looks like this depends on. i'll install sc3-plugins and test this out.

if nothing else we might note in the readme that you can get doc strings for Ugens if you have sc3-plugins installed?

ntrocado commented 3 years ago

You don't need sc3-plugins! *sc-plugin-paths* is convenient just because the directories there share the same parent as the possible path to the help documents.

i never have sc-plugin-paths bound.

You don't have the variable bound or is its value nil? Maybe because in your system there are none of the directories listed here?

If this is the case, I think the solution would be to have a new var *sc-root-paths*, from which both *sc-plugin-paths* and *sc-help-paths* would derive. I'd be happy to amend if this is indeed appropriate...

byulparan commented 3 years ago

It works on MacOS. very Cool! Thank you :-)