Request for extension of comment in subWikify function

[Martin Budden]

I'm not a fan of overcommenting code, and I think TiddlyWiki has the
balance about right. However there was one instance where I was puzzled
for a little while and an where an extension of the comment would have
helped.

Wikifier.prototype.subWikify = function(output,terminator)
{
// Temporarily replace the output pointer
var oldOutput = this.output;
this.output = output;
...
}

Can you change the comment to:

"Temporarily replace the output pointer, required since subWikify can
be called recursively"

It took me a little while to realise a recursion was involved, since it
is indirect: subWikify can be called from within the
config.formatters.handler function that is called from within
subWikify. Having this little tip would have helped.

[Jeremy Ruston]

Cool, thanks Martin,

Cheers

Jeremy

--
Jeremy Ruston
mailto:jer...@osmosoft.com
http://www.tiddlywiki.com