[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Sc-devel] what needs to be done before 3.2?
On 20 Dec 2007, at 22:35, Andrea Valle wrote:
(First: thanks to all you devs, because I've just come back from
Palermo where I tested live my system: it was a big big fun, and
max/msp people at the 2-days course were impressed by sc...)
1. I've used the helper classes for GeoGraphy and seems to work
really fine, hugely increasing the documentation task's speed,
apart form a strange question of pale colors, which has been
already noted by Thor....
I'll surely take a look into this (ans ask you, Scott, if I still
can't understand what's going on), and into the classes more in
general. Here I'm speaking of those classes working in this way:
Help.makeHelp(AClass)
2. For what is concerning autogenerating docs from comments in
sources (the other idea we discussed), the class I posted was just
a test to show a possible mechanism. It actually does not work into
the real world.
More, first a strong agreement on how to mark up sources would be
needed. This would not be bad in a more general sense as there's a
wide variety of way of commenting sources, as far as I can tell.
But maybe this is simply not a problem at all.
Well, that'd be really moving towards a true autodoc thing.
So:
1. I'll revise the helper classes.
2. I would suspend the autodocumentation from source mechanism
because it needs a more consistent approach
What's the deadline for 3.2?
I think we said Jan 1st, to be followed by testing.
Best
-a-
PS: should not be useful to have e.g. a wiki page (could be Jan's,
I guess) where to keep track of thing to be, requests, etc?
There are bug and feature request trackers on the sf project page.
S.