I like the idea (++) and have even used the idea myself in the past in the Tk::JComboBox docs, and plan to implement it within other modules I publish and/or maintain. However, I disagree that Perlmonks should be where this information is kept. It should be in the docs. Barring that, I think AnnoCPAN is the best place for others to add this information. AnnoCPAN provides a mechanism that can provide feedback to module authors, and even if authors don't add it, the annotations remain "close" to the documents through the service.
If you're looking for something to place on Perlmonks, I think maybe a longer tutorial or article (similar to the survey you mentioned) that goes into more depth might be worthwhile
Rob
-
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.
|
