[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Sc-devel] SC3.2 deadline approaching

I'd be very happy to have these in the distribution and serving as the 'official best practice' way to make a help file.

This would go a long, long way to creating uniformity in the doc (one of the advantages of an autodoc solutions) without losing any of the advantages of the current version.

Please, let's include them rather than make them a Quark! :-)

I'd say add them for 3.2 and we can work out the corner cases (such as Thor encountered) later. This is not performance critical code.


On 20 Jan 2008, at 17:49, Dan Stowell wrote:

Hi -

Haven't used the latest version (sorry) but I think as thor suggests,
it seems quite appropriate for it to be a quark. Just my 2p, happy to
be outvoted.


2008/1/20, thor <th.list@xxxxxxxxx>:

Hi Andrea

Just curious: has anyone tested and/or included the Helper classes in

Yes, I wanted to make a new helpfile (A better one for one that I have
already) today.

I ran the latest Helper classes that you sent (early Jan) and it only brings
up the
_existing_ helpfile for the class. Then I try .makeAutoHelp and
but those give me the following error (pasted below)

So basically (trying for 5 minutes) I couldn't use your system to create a
for my class (that already had a helpfile). Your earlier system worked
better for me.

It was only when I removed the older helpfile that I could use your system
create a new one.

That said, I think your system is essential for making uniform helpfiles and
should be either available as Quarks or in the distro. It is a topic of
whether it needs to be part of the distro as most developers know how to use
the Quarks system.

Here is an example using SCTextView as the desired documented class:

Help.makeAutoHelp(SCTextView) // prompts for a path

ERROR: Message '<' not understood.
   Integer 21


(I tried sending the whole dump but this evil mailing list rejected the size
of the mail)

Sc-devel mailing list

Sc-devel mailing list