I must say that when the problem is fixing code that has
been
labeled
"... a useless module that gives you your arguments
without the first one if that's a class or object ...",
then maybe you should simply concentrate on providing
decent documentation. Right now the documentation for
OOorNO is horribly lacking in instruction,
examples, and has no selling points whatsoever. You should
address (at least indirectly) the following questions:
- What does it do?
- How do i use it?
- Why should i use it?
I am a
CPAN author
myself, the first thing i did before i posted my module
was some RTFM'ing:
Ovid hit the nail on the head in one of his
use Perl;
journal entries:
"If you're going to write a CPAN module, don't skimp on the documentation. If I can't understand it, I probably won't use it." brian d foy's
words are
golden as well - you would be wise to read them.
Time to toot my own horn: i am proud of the documentation
i wrote for DBIx::XHTML_Table, i invite you to
peruse it and learn from it. The first page contain a
Synopsis that shows how to quickly use the module. Next is
a brief Description that together with the Synopsis answers
all three questions that i presented above. After that is
a lengthy break down of the API and how to use each method.
Also, i created a home
page for the module which includes a Tutorial and a
Cookbook for doing various, specific tasks with the module.
Even though nobody really uses my module, at least it's
well documented. I am glad i wasted many hours on that. :)
Hope this helps and welcome to the Monastery. :)
jeffa
L-LL-L--L-LL-L--L-LL-L--
-R--R-RR-R--R-RR-R--R-RR
B--B--B--B--B--B--B--B--
H---H---H---H---H---H---
(the triplet paradiddle with high-hat)
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.