Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

comment on

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

Regarding the hate-in with Data::Dumper, of which I've not found issue, my suggestion would be to simply add text as follows (or something to this effect):

If you find the format of Data::Dumper to be too difficult, try installing and using Data::Dump, YAML, JSON, Data::DumpXML, among other possibilities, instead. They all fill the same need, with varying output.
In my mind, it's more important to get them debugging than it is which tool they're using. Offer choices, but get the concepts across. Preferably with something they can start using immediately, and let them advance into other options.

In that way, I'd suggest that you point out when a tool you're suggesting to use may need installation, such as YAPE::Regex::Explain in #8.

Also, for #3, eliminate the word "colon" from the text, merely suggest "delimiters". Then you can give examples, "such as colons." Personally, I prefer square bracket delimiters ([]) - even if there are brackets in the text I'm printing, I usually find that I'm not confused, whereas trying to follow colons can give me eye-strain. Thus, I think that'd make another good example. (Well, I think it makes a better example, but I'm not writing this checklist ;-) )


In reply to Re: RFC: Basic debugging checklist by Tanktalus
in thread RFC: Basic debugging checklist by toolic

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 having a coffee break in the Monastery: (4)
As of 2024-03-29 05:27 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found