On 17 Dec 2004, at 20:46, Julian Rohrhuber wrote:
In general the documentation is brief, often too brief IMO. SC has a somewhat different user base than many general purpose computer languages, and I think there has to be some allowance for the different backgrounds that users have. The exception to this brevity are a few things like the server construct classes, to which I've added explanations that just weren't found elsewhere. I have thought that much of that could be separated out into different files though, i.e. method reference versus general info. We could look at doing that if it seemed like it would work.This comment illustrates exactly the problem with the bulk of the documentation. Our tendency is to document classes, not usage patterns. This makes the documentation useful for people who already know what they're doing, but not so helpful for people who don't.I'd also try to make class documentation as brief as possible and move the longer explanations to specific tutorials. Also people who do know how things work have to quickly look up methods at time. Long helpfiles make that difficult.--
Is that what you're referring to Julian, or are there other ones which you feel are a problem?
S.