Re: Possible docs patches

On Mon, Mar 27, 2006 at 10:06:46PM +0100, Norman Gray wrote:
> 
> Greetings.
> 
> I've attached a small patch with documentation suggestions.  These  
> are against the current SISC HEAD.
> 
> This contains a few additions to the recently expanded (thanks!)  
> description of how to call Scheme from Java.  In particular, it  
> mentions the execute(sisc.interpreter.SchemeCaller) method as well as  
> the execute 
> (sisc.interpreter.AppContext,sisc.interpreter.SchemeCaller) method,  
> and suggests that the former is the preferred one if the programmer  
> has no particular need for a non-default AppContext or Heap.  This  
> was the impression I'd gleaned from the recent discussion of this new  
> interface here -- perhaps I'm wrong.  My aim was to emphasise the  
> simplicity of the new interface.  I made a few other wording changes  
> nearby that seemed worth while.

Hmm, the original docs tried to make that AppContext parameter optional, 
but apparently that has no rendering equivalent in Docbook for Java
methods.  

I'm reviewing your patch now, but I suspect it will be worthwhile to 
apply.  I'm not opposed to Javadocs in the distribution.  In the past
we hadn't added them because so little was Javadoced.

	Scott


-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642