Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
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.


In reply to Re: On providing documentation with your modules by matija
in thread On providing documentation with your modules by Jouke

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    [Corion]: Discipulus: If you want to rewrite the SVG, then yes, something like XML::Twig should be enough. I would try to not modify the SVG but only modify the display, but so far I haven't convinced IE to change the style...
    Corion gives up
    [Discipulus]: ah! so you mean if i need a static image i can use Twig, if on the fly better css selector and mody attrs (jquery?), rigth?
    [LanX]: not sure what you guys are taking about, but a DOM manipulation in JS shouldn't be difficult
    [Corion]: Discipulus: Yeah, that's what I would try (but so far, I can't even change the colors manually in the SVG, which is why I gave up ;) )
    Discipulus bad sign..
    [Discipulus]: italian doc says to modify somehow the initial SVG before using it with D3.js
    [Discipulus]: LanX the fact is that my js ability is even poorer than my Perl one..

    How do I use this? | Other CB clients
    Other Users?
    Others pondering the Monastery: (13)
    As of 2017-03-23 09:42 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      Should Pluto Get Its Planethood Back?



      Results (285 votes). Check out past polls.