Re: [pygame] updating the docs

[Phil Hassey <philhassey@xxxxxxxxx>]

Pete,

Looks good.  Not to nit pick the file format, but to
nitpick the file format --

If it's going to be a "tagged" format, I'd suggest
using tags like
<method> ... </method>  <class>...</class> ..
<function> .. </function> ..  That would make sense,
and be easier to have a parser know what is what. 
Maybe throw in a few tags like  and <summary>
</summary> and <description> .. </description> ..
<example> </example>

That would make the content more readable and more
useful for a script to parse.  

If you think this is a good idea, I'd be glad to help.

(I'm thinking a somewhat about making an interactive
version of the docs for the website -- with ability
for users to submit comments.  So having the docs in a
more standard format would be nice :)

Phil

--- Peter Shinners <pete@xxxxxxxxxxxx> wrote:

> I've updated the pygame documentation with a new
> version of things. This
> should be a good thing, but it likely needs a round
> or two of proofing
> and fixes.
> 
> I've gone through every function, method, and object
> and redone the
> docs. Things are reorganized a bit, and things
> should be a bit clearer.
> Unfortunately it's been a long span of time between
> me starting and
> finishing the revisions. I haven't gone back myself
> to check for grammar
> and sanity much yet.
> 
> The biggest difference is that the reference is no
> longer generated from
> the docstrings. It is now pulled into separate
> simple text-like files.
> I'm hoping this makes it easier to get cleanups and
> submissions. It also
> makes languages translations more of an option.
> 
> http://www.pygame.org/docs/
> 
> If you want to start editing the docs, grab this
> archive and send me the
> changed files.
> http://www.pygame.org/ftp/contrib/pygamedoc.zip
> 
> 
> 



	
		
______________________________________________________ 
Yahoo! for Good 
Donate to the Hurricane Katrina relief effort. 
http://store.yahoo.com/redcross-donate3/