Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
I think it's actually a reasonable piece of documentation; it contains at least one piece of information that I didn't know for several years after using perl. Specifically, it took me about three years before I realized that the perldoc command had the "-f" switch.

When I first started learning perl, I usually wanted to read the entire manual page, anyway. To my mind (and perhaps in the earlier versions of perldoc, I don't remember now), "perldoc" <topic> and "man" <topic> were essentially equivalent.

It wasn't until I moved to the ActiveState release of perl (with no man pages under Windows), that I realized how useful "perldoc -f" was.

So I'd support the notion of "meta-documentation" for that reason alone. Additionally, online documentation written for different intended audience than the traditional CS student with a background in C and UNIX might be helpful as well.

--
Ytrew


In reply to Re^4: Perl documentation documentation by Ytrew
in thread Perl documentation documentation by brian_d_foy

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



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others exploiting the Monastery: (2)
As of 2024-03-19 04:36 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found