Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

Re: CPAN not so comprehensive

by VinsWorldcom (Prior)
on Mar 27, 2018 at 14:58 UTC ( #1211855=note: print w/replies, xml ) Need Help??

in reply to CPAN not so comprehensive

If you have a specific Net::SSH2 question - ask it! I too have had issues trying to understand its use but finally figured out some of my problems. Another challenge is that I'm exclusively on Windows / Strawberry Perl so that's (one of) the only SSH modules that will work - and it comes bundled / compiled with Strawberry in vendor/lib. I was able to understand enough to cobble together a simple SSH client and the CPAN Net::SSH2::Cisco module - a drop in replacement for Net::Telnet::Cisco. Happy to share that code if you think it will help.

That said, in a more general sense, I try to put probably more documentation in my releases than most. I started with inline comments but then moved to POD once I understood what that was, how it worked, and how superior it is to understanding usage for new users. I (most of the time) try to include a pretty complete SYNOPSIS and either an EXAMPLES section or provide bin/ scripts that provide basic functionality which a user can use right away, or customize to their heart's content.

True, some authors just don't document or don't document "well", but that's relative. Someone who writes a module is sometimes so familiar with the way it works and what it does, they may sometimes lose sight that other users may not be as familiar and need a jump-start / working example to build on.

Good luck!

Replies are listed 'Best First'.
Re^2: CPAN not so comprehensive
by Anonymous Monk on Mar 27, 2018 at 22:53 UTC

    Thank you all for fistful of valuable informations. Now i see that being a perlist isn't so colorful and fluffy as being pythonist, but on the other hand, what comes in pain gives more gain ;)

    Like on this meme ,just s/Gentoo/perl/
      …being a perlist isn't so colorful and fluffy as being pythonist…

      I must add that Python is scaly and black and white, no softness or shades of color at all. :P

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (3)
As of 2021-01-24 14:55 GMT
Find Nodes?
    Voting Booth?