comment on

If you ask me, reading the documentation for everyday CPAN modules (as well as many others) is a hassle. They are usually written with the seasoned Perl programmer in mind. With that said, it can become very difficult to understand CPAN documentation if it isn't a tutorial or walkthrough.

For example, JSON.pm is an app that I will soon be using. The issue is, in my eyes, the documentation is poor. It gives you a bunch of functions and what they do, but it says nothing about how to do it, besides the synopsis, which really doesn't help much

So, my question to you is, how can I become better at reading CPAN module documentation, and understanding how to use modules that don't come with books or tutorials in them?

--perl.j

In reply to How to read CPAN documentation by perl.j

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.


Pathologically Eclectic Rubbish Lister
	PerlMonks