[Borges-users] Re: Borges Documentation

[Eric Hodel]

Kaspar Schiess (eule at space.ch) wrote:

> Hello Eric,
>
> | I was thinking the opposite.  Keeping method documentation in the code
> | and using RDoc to extract this and insert it into an rd file (or files).
> 
> Yeah, good idea: That way code is documented and we still have total
> control over output and structure of end-user documentation !
> Maybe we could just produce files that have names like
> 'Borges-Session.rd' and can be included in the main RD documentation
> wherever we want, containing just method and class documentation ?

I'll still have to write an RDtoZenWebRenderer for ZenWeb, that will
pass along the links into RDoc for web rendering... or something.

> | An integration document would be nice, describing all the various ways
> | you can run the Borges backend.
> 
> Yeah, and I will be able to write it, since I am pretty clear about
> this. It will be short at first, so I don't get bored ;).

Ok.  When you're ready, go ahead and either submit the file as a
patch on http://rubyforge.org/projects/borges/, and I'll give you
CVS a commit bit on approval.

> | I'd rather move this discussion over to borges-users at rubyforge.org,
> | since it may be of interest to others.  I still have to get the project
> | site set up.
> 
> Did you subscribe there yet ?

Hrm, I'm the administrator, but not subscribed.  Now fixed.

> Working on the transactions in Borges... I have weird effects here. Give
> me another day and I will probably submit a patch.

Yes... I'm not 100% sure those work correctly.

> A thing that is missing completely in documentation: What is this talk
> about user interface threads in seaside ? Can you do that too with
> Borges ? How ? (If you answer, just remain conceptual, I will gather the
> details from source code !).

Can you give me an exact pointer?

I think this is the same idea as "session forking" where you can do two
operations with the same session.  Each fork of the session will
backtrack over its history independently, but session state will remain
global to all forks.

-- 
Eric Hodel - drbrain at segment7.net - http://segment7.net
All messages signed with fingerprint:
FEC2 57F1 D465 EB15 5D6E  7C11 332A 551C 796C 9F04