Re: [pygame] Missing documentation

[Troels Therkelsen <tt@xxxxxxxxxxxxxx>]

Terry Hancock wrote:

On Saturday 03 September 2005 09:56 am, Troels Therkelsen wrote:
  

I noticed that the cursor page is missing from the documentation;

   http://www.pygame.org/docs/ref/pygame_cursor.html#compile
    

Somebody forgot the "s":

http://www.pygame.org/docs/ref/pygame_cursors.html#compile

works fine!

(Good advice for hacking around dead links, BTW -- look at the
similar links on the offending page and test for obvious
mistakes like inconsistent pluralization and capitalization).
  

I'm afraid it's not quite that simple.  While I'm willing to concede that
there should only be pygame_cursors.html, there still mysteriously are
two links to cursor(s) in the list of subpages.  One of those need to be
removed, then.

Secondly, pygame_cursors.html does not contain the documentation
for cursors.compile(), only cursors.load_xbm().

The documentation which is in the distributed 1.7.1 release of
Pygame is not broken, but it does have both cursor and cursors
as working documentation links, even though they both refer to
(different parts) of the same Python module (cursors.py).

It is unclear to me why this distinction is there, to be honest.  I only
can repeat what I said in my original mail that there's missing
documentation, and it's not just a matter of adding an "s" to the above
link, the file pygame_cursor.html needs to be added to the ref dir.  Or
maybe Pete (or whomever wrote the documentation) could tells us why
the two pages are split so we can decide whether they should remain split
or be merged into one page.

The documentation should be easy enough to extract from the
module itself, seems to be that way all other documentation was
originally compiled.
    

This would seem to be a website issue. My distribution of PyGame
includes the cursors module documentation with correct internal
links.  Obviously the navigation links on the website have the
error

Just to be clear (I know I'm repeating myself here), there's no error in the
navigational links, the error is a missing file.

Should be a cinch to fix for the webmaster.
  

I agree.

-- 
Med venlig hilsen / Best regards,

Troels Therkelsen
Programmer
Nitram Lexa ApS
Maglebjergvej 5A
DK-2800 Kongens Lyngby
Denmark

E-mail: tt@xxxxxxxxxxxxxx
Web: www.nitramlexa.com

Internet - e-learning - video streaming

begin:vcard
fn:Troels Therkelsen
n:Therkelsen;Troels
org:Nitram Lexa
adr:;;Danmarksvej 5A;Kongens Lyngby;;2800;Denmark
email;internet:tt@xxxxxxxxxxxxxx
title:Programmer
tel;work:+45 70 25 24 23
tel;fax:+45 70 25 29 23
tel;home:+45 38 81 33 66
tel;cell:+45 25 39 14 69
x-mozilla-html:FALSE
url:http://www.nitramlexa.com
version:2.1
end:vcard