Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

Re^3: Documentation: POD vs Comments (visual)

by tye (Cardinal)
on Jul 22, 2011 at 09:24 UTC ( #916084=note: print w/ replies, xml ) Need Help??


in reply to Re^2: Documentation: POD vs Comments (visual)
in thread Documentation: POD vs Comments

Do you use syntax highlighting... in your diff tool? In your merge tool / conflict resolver? In your grep tool? In your print-outs? In your code reviews? In your e-mail? In your 'blame' tool? In your repo browser? etc.

And how do you manage to understand the example code in the POD if the colors aren't right?

Of course, even when you are in a context where you can have your color hints crutch, POD still gets in the way of reading code.

As a side note, IIRC, you use emacs.

- tye        


Comment on Re^3: Documentation: POD vs Comments (visual)
Re^4: Documentation: POD vs Comments (visual)
by moritz (Cardinal) on Jul 22, 2011 at 09:49 UTC
    Even if the diff tool had syntax hilighting, it usually wouldn't have enough context to know if a chunk is part of a POD block or not.

    Update: An actual diff tool usually has enough context, just a tool for viewing a patch/diff usually doesn't.

Re^4: Documentation: POD vs Comments (visual)
by LanX (Canon) on Jul 22, 2011 at 12:15 UTC
    > As a side note, IIRC, you use emacs.

    good point there you can indeed diff with intact syntax highlighting! :)

    Cheers Rolf

Re^4: Documentation: POD vs Comments (visual)
by tinita (Parson) on Jul 22, 2011 at 18:07 UTC
    Do you use syntax highlighting... in your diff tool?
    I love vimdiff. It can be really helpful if you have more complicated diffs. The code has syntax highlighting and additionally the different lines are coloured.

      Other than the sad scenario of leaving ${EDITOR:-vim}, what do you think of meld?

      After working with meld, I found myself lost when presented with "emerge" window. I should really look into a ${"merge tool":-vimdiff} that runs in xterm. (sdiff(1) -- while using "mergemaster" -- is too tedius to work with when faced with lines longer than a few words.)

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://916084]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (5)
As of 2014-10-02 09:22 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    What is your favourite meta-syntactic variable name?














    Results (52 votes), past polls