[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

RE: [pygame] pygame website - request for suggestions



I've noticed a few "bugs" with the Pygame documentation on the site.  I'm far from a pygame-pro so these may be deprecated features or me just misunderstanding things, not knowing where to look, etc., but I've noticed the following:

#1
The "Scrap" topic link doesn't show up in the header on this page:
http://www.pygame.org/docs/
But it will appear when you click any of the other topic links in the header (pygame, font, draw, etc.).

#2
Googling for certain keywords, I can find the two links below (color & constants), but I can't find any way to navigate to these pages from the main documentation link (http://www.pygame.org/docs/)
http://www.pygame.org/docs/ref/pygame_color.html
http://www.pygame.org/docs/ref/pygame_constants.html

#3
There is some potential for odd formatting when a method's documentation contains a link to another method (ex: the docs for pygame.mixer.init refer to pygame.init, pygame.mixer.pre_init and pygame.mixer.quit).  It looks like the method that is referred to gets its short description copied into the text with a smaller font after the method name.  Good idea, but this can be difficult when reading along.  Hard to tell what is plain text and what is the referenced method's short description.  Can you put the short description in parenthesis or something to make it clear that the short description isn't meant to be read along with the sentence?  Certain browser settings format the short description almost identically to the regular documentation (I usually use Opera and it is difficult to tell at a glance the text is different.  IE does a bit better).  This makes it even more difficult to differentiate between the two.  FWIW, looking at the html source, these references are enclosed in <tt> tags with the short description getting a <font size=-1>.

Hope that makes sense.  Feel free to ask for clarification if necessary...

Great site!  Keep it up!  I'd be lost w/out this site!

-Scott


> Hey,
>
> It's been one year since I launched the new pygame website.  I hope
> to have a bit of time during the next month to do some updates to it.
> So if anyone has:
>
> - bug reports
> - feature requests
> - etc
>
> To suggest, now's the time!  If anyone makes a feature request that
> you think is great, please reply to their message and say so -- the
> more people want a feature the more likely I'll be to implement it.