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

Re: [pygame] Using reStructuredText for document sources



Currently makeref.py is hard coded to add these descriptions. I expect with reST it can be moved to a template. Then the descriptions can be included, excluded, or become a pop-up as desired.

Lenard

On 03/03/11 05:30 PM, Greg Ewing wrote:
Renà Dudfield wrote:

It's a short description of the function - not so much a long winded one.

It's still *far* longer than I want to see *every* time
the function is so much as mentioned, though!

perhaps add a title attribute to the link (which would give the description on hover over the link).

+1. That would be a excellent solution.

[Reading the current pygame docs always makes me think of a
passage from Terry Pratchett's "Pyramids", where a young,
inexperienced pharaoh is hold a court session, and a court
official is "interpreting" the naive things he says. Every
time the official mentions the pharaoh's name, he uses his
full official title, which is about five lines long. This
happens several times in each paragraph. It makes for
extremely funny comic fantasy, but it's not the best way
to write documentation, IMO!]