Generally speaking, some of the most frustrating problems to solve are those where the software tries to hide the actual error messages and explain the problem in "layman terms" so the "user won't get confused". Yes, Microsoft, I'm looking at you. The result is the same every single time; the actual meaning of the original error message is lost and the end user has no way of discerning exactly why he's getting some misleading message about "the PC is powered off" (because it actually isn't) or "the ethernet port is disabled" (no, it's not).

If at all possible, relay whatever error message the module or operating system returns in verbatim to the user and then optionally ADD hints for well known error messages. Include enough information to actually troubleshoot the problem, such as the IP address and port number. Perhaps the port is blocked by a firewall? Someone typed the IP address wrong in a config file?

Good:

No route to host
Hint: Is the FOOBAR server running?

[download]

Better:

Unexpected error connecting to #.#.#.# tcp/#: No route to host
Hint: Is the FOOBAR server running?

[download]

Bad:
Error 111

Infuriating:
Server PC down

-- FloydATC

Time flies when you don't know what you're doing

In reply to Re: Are their Documented Default Exit Codes for Certain Modules? by FloydATC
in thread Are their Documented Default Exit Codes for Certain Modules? by mmartin

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, details, 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, summary, 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.