Re: [pygame] pygame documentation

[Jasper Phillips <jasper@peak.org>]

On Thu, 20 May 2004, Pete Shinners wrote:

> enrike wrote:
> > opensource style of documentation and he was asking all the time for an 
> > API documentation like the one with pyOpenGL for example.
> 
> What part of the pyopengl documentation do you mean? I see a long list 
> of all functions and each function has a list of the arguments needed 
> and a paragraph or two on documentation.

Overall I find the pygame docs much more succinct, although the pyopengl
docs are more comprehensive.  The main thing the pyopengl docs have that
pygame docs don't are links to examples using the methods in question.  This
is very nice, e.g.

http://pyopengl.sourceforge.net/documentation/manual/glTexImage2D.3G.xml

One particular pygame doc pet peeve!  Where are the args to
Surface.__init__() described, and why isn't it here?:

http://pygame.org/docs/ref/Surface.html

-Jasper