[Lift] Re: Documenting the source code / supplementing the API docs

2010-02-26 Thread Stuart Roebuck
I've spoken to David off- list and unfortunately I am not comfortable signing the particular IP assignment contract I was sent as it appears to me (but not to David) to be ambiguous in whether it covers what I commit or also any other code I am working on in connection with Lift (e.g. the code of

[Lift] Re: Documenting the source code / supplementing the API docs

2010-02-26 Thread Timothy Perrett
Stuart, You can still contribute to the wiki and of your findings or musings - that is totally open. Cheers, Tim On Feb 26, 9:59 am, Stuart Roebuck stuart.roeb...@gmail.com wrote: I've spoken to David off- list and unfortunately I am not comfortable signing the particular IP assignment

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-26 Thread Stuart Roebuck
Tim, Thanks - that sounds like a good idea. Stuart. On 26 Feb 2010, at 10:50, Timothy Perrett wrote: Stuart, You can still contribute to the wiki and of your findings or musings - that is totally open. Cheers, Tim -- You received this message because you are subscribed to the Google

[Lift] Re: Documenting the source code / supplementing the API docs

2010-02-26 Thread Stuart Roebuck
Okay - I've added a page to the wiki:   http://wiki.github.com/dpp/liftweb/sitemap-basics On Feb 26, 11:20 am, Stuart Roebuck stuart.roeb...@gmail.com wrote: Tim, Thanks - that sounds like a good idea. Stuart. On 26 Feb 2010, at 10:50, Timothy Perrett wrote: Stuart, You can still

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-26 Thread Mads Hartmann Jensen
Cool, great job - keep them coming :) On 26/02/2010, at 14.36, Stuart Roebuck wrote: Okay - I've added a page to the wiki: http://wiki.github.com/dpp/liftweb/sitemap-basics On Feb 26, 11:20 am, Stuart Roebuck stuart.roeb...@gmail.com wrote: Tim, Thanks - that sounds like a good

[Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread Stuart Roebuck
Sorry for the slow response—was away for a family weekend! I have limited knowledge of Lift internals… However, my view is that it is often easier to document code when you don't know it well than when you do, because you soon loose interest in documenting things that are obvious to you. What I

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread Timothy Perrett
We are interested in the contribution of course... I think the issue is mostly about how we take patches for this. Someone on the team would need to own this and merge your documentation changes into the master (provided DPP has no objections to this - seeing as its documentation I doubt he

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread Stuart Roebuck
Perhaps it's easier for me to do a fork on GitHub? Then any documentation submissions can be taken across at a time that suits whoever is doing it rather than synced with my submission timeline? On 22 Feb 2010, at 17:05, Timothy Perrett wrote: We are interested in the contribution of

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread Ross Mellgren
I will do this, and give feed back if it ever becomes too much load. -Ross On Feb 22, 2010, at 12:05 PM, Timothy Perrett wrote: We are interested in the contribution of course... I think the issue is mostly about how we take patches for this. Someone on the team would need to own this and

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread Stuart Roebuck
Great... okay, I’d better do some writing :-) In the absence of a decision I’ll try to minimise special coding in comments but use Scaladoc 2 standard if necessary rather than HTML as that makes it future proof but still readable for both. Stuart On 22 Feb 2010, at 17:32, Ross Mellgren wrote:

Re: [Lift] Re: Documenting the source code / supplementing the API docs

2010-02-22 Thread David Pollak
The easiest thing is if Stuart signs an IP assignment, becomes a full-fledged committer and thus we keep the IP clean. Stuart, if you're interested in learning more, please contact me off-list. In terms of the documentation standards, I'm okay with anything that the rest of you-all want. I'm