[Linux] Re: [Sc-devel] freq vs kfreq docmentation -> 3.1

[Scott Wilson]

On 20 Oct 2007, at 15:46, Nick Collins wrote:

> Hi Tom,
>
> Checking the UGen source, I believe the issue is that you can only  
> plug in k rate UGens to control frequency. I agree that it's  
> confusing for students though and shows inconsistent argument  
> naming! There are many other UGens where the allowed rate of an  
> input is just mentioned under the description of each argument. So  
> the kfreqs can be removed, and a note added to the help file under  
> the freq argument to that effect.

Hey Nick,

I've committed these, and added the notes. I think kargs and iargs  
should be renamed as this has been applied inconsistently, and IAC  
reminds one unpleasantly of CSound. (ouch! :-p)

>
> I'm happy to help with help file updating next Weds/Thurs once free  
> of immediate deadlines. I've added the kfreq thing to my growing  
> list. Scott, also happy to help with other files like Object;

This would be very cool.

> I'd like to rationalise the main help as well, perhaps adding a  
> quick start up guide + platform specific READMEs as the most  
> obvious link to direct anyone new to the program to the essential  
> info for their platform.

Yes, I think it should be drastically simplified, and mostly just  
point to Dan's new help browser, and some basic documentation and  
tutorials. At issue is if Marije has done anything with the  
categories yet. I think for the moment it could just point to  
Help.all or Help.dumpTree for linux non-GUI users.

IAC if you'd like to collaborate on that it would be great to have it  
for 3.1!

I have one other doc issue, but I'll raise it in another thread.

S.