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.)

[download]

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.

In reply to Re: Re: Writing Good Documentation by jepri
in thread Writing Good Documentation by defyance

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.