Beefy Boxes and Bandwidth Generously Provided by pair Networks
laziness, impatience, and hubris

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

This meditation is my reaction to reading Brian Ingerson's article on his new IO::All module, which (in brief) is an API for doing IO.

Now, IO::All is interesting for a number of reasons, but I'm interested only in the design of the API in this node. If you read the article, or download the module and play with it, it's my opinion that you'll find this is a pretty good API. Some parts of it I'm less fanboy of, but overall I think it's great - it hits you as, "why didn't Perl have this from the start?!".

How does one go about designing this kind of thing? In fact, do you design it at all? Ingy put it down to XP practices, at least in part. And there is definitely some "knowing when to break the rules" going on - such as exporting, by default, a function to the caller. This kind of thing is usually frowned upon, but is... well, Spiffy.

There is, of course, no real answer to the "how to I get my API right from the start?". It's likely even Ingy didn't get it right on his first attempt, maybe not even his second. And, of course, the light sabre is the tool of the Jedi, which probably impies something. But, what works for people? Let the sands of time erode the rough edges? Decimate the functionality with every major release, to instill fear into the remaining functions? Keep rewriting it until you like it? I guess this is a fixed-chord problem, but your thoughts are most welcome.

In reply to Ingy's "Swiss Army Light Sabre" - or, "how do you design your APIs?" by kal

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?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others surveying the Monastery: (4)
    As of 2018-05-27 06:04 GMT
    Find Nodes?
      Voting Booth?