Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

Re^2: A Peeve of Great Pettishness

by BigLug (Chaplain)
on Nov 01, 2005 at 10:27 UTC ( [id://504560]=note: print w/replies, xml ) Need Help??


in reply to Re: A Peeve of Great Pettishness
in thread A Peeve of Great Pettishness

While we're having a rant about documentation ...

If you're writing a module tell me exactly what it does in the simplest terms possible, sure it obvious to you what it does, but while it might solve my problem I won't know what it does unless you tell me!

There are too many modules whose documentation is typically:

Name

Purple::Blovinator

Description

Implements lib_blovinator on the purple operating system. See lib_blovinator's documentation for interface.

Firstly, I have no idea what lib_blovinator does. It may solve my problem. Secondly, while you may be able to map a C API to perl simply by reading the C docs, not everyone can - including myself.

OK, I feel better now.

Replies are listed 'Best First'.
Re^3: A Peeve of Great Pettishness
by Perl Mouse (Chaplain) on Nov 01, 2005 at 12:31 UTC
    I fail to see the problem. If you can't understand lib_blovinator's documentation, it's unlikely to solve your problem anyway.

    Sure, it would be nice if there's more documentation. But people getting software for free who still whine it's too difficult for me, you must put more work into it, because I won't really irk me.

    Perl --((8:>*

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://504560]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (5)
As of 2024-03-29 13:58 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found