Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

Whether your sub actually returns anything to the caller is one thing, but whether its return value means anything is another.

In the module's documentation, it's fine to either leave out a mention of what the sub returns, or explicitly say that what the sub returns is unspecified. This tells anybody using your sub that they should not rely on anything it returns. This way, in a later version of the module, if you decide that you want to return true, or a status code, or some kind of error message, you can, and you won't break any existing code.

For a little more on this, see the "Specifying semantics" section of Ned Batchelder's essay on interfaces. He uses the term "undefined" instead of "unspecified", but that's just because the languages he usually programs in probably don't have undef.


How do I love -d? Let me count the ways...

In reply to Re: Bad Module Code by QwertyD
in thread Bad Module Code by CodeJunkie

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



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others learning in the Monastery: (3)
As of 2024-04-18 00:26 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found