I'm not going to go into the major aspects as I have not yet written up POD myself, just a couple of minor points.
- I'd like to teach the world to sing...
Before you go any further, if you plan on using a table for layout, STOP! Tables are for tabular data, use div elements to lay out your webpage.
- I'd like to teach the perlers a THING...
code is an anonymous sub.
If I don't know what that funny argument sub {} is, I could always risk asking someone on a forum, or perhaps rtfm. The presentation of the usage should make the argument requirements apparent. If you are going to describe the arguments, consider how consistently you describe them across all the method descriptions. I actually began to look for a hash key 'code' to see what value I would have to provide as an a argument before I realsied you just meant, the first argument is code - how does File::find handle that in Pod?
- I'd like to teach the italians about drawing...
paragraphs, sparagraphs, spaghetti giraffes?
-
Introducing a whole new way to do something as second nature as write a paragraph element, could really do with it has it has own description. You may just be reinventing the wheel in a way that people have not considered previously, and it would be a shame to hide this away by muddling it up with the straight forward paragaraph element method. Or it may be a really bad idea, in which case it can be easily ignored or redifined, either way the paragraph separator routine, dare i say it.... needs separating
On another point more along the coding itself, why ask the user to provide the $tab argument for every method? Could you not implement this as default module behaviour, and then describe this in the Pod?
I hope these comments are helpful in your redraftings.
-
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.
|