Interesting related discussion:
https://groups.google.com/forum/?fromgroups#!topic/comp.lang.python/Dq11ce39xtc
Source is great documentation by itself I agree.
But when I started to go through source,
I can see a couple of functions with no docstrings, there may be more like
so.
And for a total newbie to source, just be there to troubleshoot something
it'll be hard.
Because there's no docstrings he must g
On Wednesday, January 19, 2011 1:14:28 AM UTC-5, cjrh wrote:
>
> There was a malfunction on my link to the module-level documentation
> that I was referring to (curse you Frames): first go here:
>
> http://www.web2py.com/examples/static/epydoc/index.html
>
> And then click on web2py.gluon.dal o
This would be a great contribution.
On Jan 19, 2:59 am, Anthony wrote:
> These are great thoughts. One comment below...
>
> On Tuesday, January 18, 2011 7:21:05 PM UTC-5, cjrh wrote:
> > documentation. Epydoc provides a space for writing module-level
> > comments, and my gut feel is that the higher-level description of the
> > sou
I hate to say it but I think the biggest problem is the Book. Don't get me
wrong, the Book is very well written and has excellent content. But it's too
much like a book and too little like online documentation.
I also think the Overview might benefit from being the creation of one
simple app, l
These are great thoughts. One comment below...
On Tuesday, January 18, 2011 7:21:05 PM UTC-5, cjrh wrote:
> I think I am in favour of your suggestion of putting references to
> source units inside the book itself. I would probably suggest that
> the format of that inclusion be little more than
On Jan 18, 10:15 pm, Jonathan Lundell wrote:
> I've been working a little on a proposal for some new cookbook sections, one
> per chapter, that provide a roadmap to the web2py source that's relevant to
> the chapter.
There are two dangers in documentation:
1) Too little
2) Too much
"Too much
This is great. Personally, I find this kind of thing very helpful.
I like the idea of having this stuff in one central location, though it
would also be helpful if the online book chapters (or even sections within
chapters) could link to the relevant parts.
Thanks.
Anthony
On Tuesday, Jan
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Hi,
El 18/01/11 16:12, Jonathan Lundell escribió:
> I could also be persuaded that the cookbook should have a briefer section on
> source browsing--just pointers to where to look--and the more detailed
> roadmap should be a more dynamic online docum
On Jan 18, 2011, at 1:09 PM, DenesL wrote:
>
> One doubt, doesn't this sound strange:
> "Rocket receives HTTP requests and passes them to Rocket"?.
Ok, well, details...
I could also be persuaded that the cookbook should have a briefer section on
source browsing--just pointers to where to look--and the more detailed roadmap
should be a more dynamic online document.
That way it'd be easier to keep the source roadmap up to date (and add new
material), and the roa
Well done!.
One doubt, doesn't this sound strange:
"Rocket receives HTTP requests and passes them to Rocket"?.
On Jan 18, 3:15 pm, Jonathan Lundell wrote:
> I've been working a little on a proposal for some new cookbook sections, one
> per chapter, that provide a roadmap to the web2py source
On Jan 18, 2011, at 12:41 PM, pbreit wrote:
> Probably any additional documentation is a "good thing". I personally like
> more practical information. My favorite framework documentation is probably
> CodeIgniter.
Using the source is definitely a backup option, when the books and other docs
don
Probably any additional documentation is a "good thing". I personally like
more practical information. My favorite framework documentation is probably
CodeIgniter.
15 matches
Mail list logo
