Re^2: a simple exercise in readability

I've been meaning to learn more about the use of POD. Maybe this will be the year I become one of the POD people.

Thanks for the tip about Pod::Usage.

print substr("Just another Perl hacker", 0, -2);
- apotheon
CopyWrite Chad Perrin

Comment on Re^2: a simple exercise in readability

Replies are listed 'Best First'.
Re^3: a simple exercise in readability by Zaxo (Archbishop) on Jan 15, 2007 at 17:05 UTC
You'll find it's really easy to learn and well worth it. I, too, learned pod after using perl for a while. The only mental shift you'll need, I think, is to remember that newlines and whitespace are significant in pod sections. Other than that, just open perlpod in a spare terminal for reference, and start writing it. For examples, `perldoc -m` will open any module or utility you like with the pod unparsed. You can also use `perldoc` to see how you're doing as you write. The utilities pod2man, pod2html, pod2latex and friends will convert pod to other formats. That is so handy, and pod so simple, that when I have to produce any covered format I first write in pod. After Compline, Zaxo	[reply]

Replies are listed 'Best First'.

Re^3: a simple exercise in readability
by Zaxo (Archbishop) on Jan 15, 2007 at 17:05 UTC

You'll find it's really easy to learn and well worth it. I, too, learned pod after using perl for a while.

The only mental shift you'll need, I think, is to remember that newlines and whitespace are significant in pod sections. Other than that, just open perlpod in a spare terminal for reference, and start writing it. For examples, perldoc -m will open any module or utility you like with the pod unparsed. You can also use perldoc to see how you're doing as you write.

The utilities pod2man, pod2html, pod2latex and friends will convert pod to other formats. That is so handy, and pod so simple, that when I have to produce any covered format I first write in pod.

After Compline,
Zaxo

[reply]