Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister

•Re: On providing documentation with your modules

by merlyn (Sage)
on Apr 17, 2004 at 13:16 UTC ( #345960=note: print w/replies, xml ) Need Help??

in reply to On providing documentation with your modules

It sounds like your module is similar to Curses, which is a thin wrapper around curses(3). But even though it's only a thin wrapper, my experience of using the Perl view of the library is mostly frustrating with the scarcity of docs.

I was similarly annoyed at the initial documentation for Tk, which again, was just a thin wrapper around the Tk library. It's gotten a lot better over time, because the documentation has been made more "native", although often only by text-wrangling the Tk lib docs in a consistent way.

Oh yeah, and I'm still annoyed at Mac::Glue, which requires me to understand all of AppleScript, most of OSA, and then some weirdnesses that are "obvious" for the Perl-OSA layer.

So please. anything you can give in the way of examples of each invocation, careful descriptions of the differences and limitations, and known gotchas, would all be most appreciated. Understand that people want concepts, structure, and examples. While the original docs for the original lib may provide concepts and some structure, they do not provide Perl-native structure or examples, and that's what you should fill in.

-- Randal L. Schwartz, Perl hacker
Be sure to read my standard disclaimer if this is a reply.

  • Comment on •Re: On providing documentation with your modules

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://345960]
[stevieb]: one of my long-running Perl procs crashes with a segfault (because it wraps C code) is crashing after an hour or so... seeing if wrapping the cli call with valgrind will produce something useful

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (3)
As of 2017-04-29 03:12 GMT
Find Nodes?
    Voting Booth?
    I'm a fool:

    Results (531 votes). Check out past polls.