Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: On providing documentation with your modules

by matija (Priest)
on Apr 17, 2004 at 05:54 UTC ( #345944=note: print w/ replies, xml ) Need Help??


in reply to On providing documentation with your modules

I suppose if all you're doing is just providing the glue between Perl and the library, you _could_ get away with that.

However, if there are any cases where what the Perl code is doing differs from what the C++ code is doing, you should document the hell out of them.

It would also be good to provide several example programs, that people can study and use as their starting point. I generaly dislike cargo cult programming, but when you're familiarizing yourself with a new library, sometimes using a modern amount of CC is the only way to get your feet wet.

Compare what you are doing to PerlTk - although most of the calls look very much like the calls in TclTk, there are enough subtle differences that they felt the need to write a lot of very good documentation for each class.


Comment on Re: On providing documentation with your modules

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others chilling in the Monastery: (8)
As of 2014-12-27 07:04 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (176 votes), past polls