in reply to Re: Writing Good Documentation
in thread Writing Good Documentation

Totally agreed. This is what set Perl apart for me, compared to other languages. When I first started using perl, and found the help system, it very nearly blew my little mind. I was left staring at the screen going "easy.. too.. use... can't.. cope.. Whoopee!".

This is after struggling with horrible C documentation like

5. Go to the src subdirectory and look at the top of topten.c. You m +ay want to change the definitions of PERSMAX and PERS_IS_UID here to get d +ifferent behavior from the high score list. 6. Edit the top sections of the src and util Makefiles. (If you are +doing a full recompile, or if you got your files from someplace besides +the official distribution, type 'touch makedefs.c' to make sure certai +n files (onames.h, pm.h) get remade instead of relying on the potentially troublesome timestamps.)

Thesedays all my code comes with examples, and where possible, a base configuration that will work on nearly all machines.

____________________
Jeremy
I didn't believe in evil until I dated it.