Python documentation too difficult for beginners
Martin Gregorie
martin at address-in-sig.invalid
Wed Nov 3 17:18:17 EDT 2010
On Thu, 04 Nov 2010 08:03:37 +1100, Cameron Simpson wrote:
> On 02Nov2010 04:23, jk <sanjo_ie at yahoo.com> wrote: | This
> (http://epydoc.sourceforge.net/stdlib/) is what I'm talking | about.
> |
> | Why aren't the official docs like this, and why has it taken me 2 days
> | of searching? All this needs is a search engine behind it and it'd be
> | perfect.
>
> It looks a lot like javadoc. But its weakness is stuff like this:
>
> http://epydoc.sourceforge.net/stdlib/Canvas.Polygon-class.html
>
> Automatic docness, no useful information.
>
You get the same problem in Java and it has exactly the same root: a lazy
programmer who can't be arsed to document his code.
--
martin@ | Martin Gregorie
gregorie. | Essex, UK
org |
More information about the Python-list
mailing list