On Feb 8, 10:22 am, "Rob Hudson" <[EMAIL PROTECTED]> wrote:
> I'd like to see more inline documentation of the code.  Some .py files
> have this but some don't.  Just an overview of what the file does, how
> things are organized, maybe some concrete examples via doctests.
> Something for the average python programmer to get a toehold into what
> the code is doing.
>
> Inline in the code seems like a good place for this to me.  It can be
> updated as the code changes.  And those digging around in the code are
> the ones who will benefit the most from it.
>
> Cheers!
> -Rob

+1

ohloh thinks so too [1]:
"Across all Python projects on Ohloh, 13% of all source code lines are
comments. For Django, this figure is only 6%.

This lack of comments puts Django among the lowest 10% of all Python
projects on Ohloh. "

[1] http://www.ohloh.net/projects/3338


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to