I'm using perl 5.8.5 under RHEL4sp4, trying to put POD in my modules these days. perldoc -v gives version v3.13 for that perl.
When I attempt to put a usage example in my POD that uses single quotes, perldoc procedes to translate those quotes into three question marks -- ??? -- even though I had indented the code example.
#!/usr/bin/perl -w
use strict;
=head1 Foo Method
Typical call syntax would be:
=over 8
my $ret = $obj->foo( 'LITERAL STRING' );
=back
=cut
Through perldoc, I get:
foo(3) User Contributed Perl Documentation
+ foo(3)
Foo Method
Typical call syntax would be:
my $ret = $obj->foo( ???LITERAL STRING??? );
perl v5.8.5 2007-08-07
+ foo(3)
I can workaround this by using double-quotes (for this example), or by inserting a literal ascii escape for the single quote (i think), but this stil bothers me, because the perldoc.perl.org/perlpod.html says "I wanted the translator to always leave the ' and ` and " quotes alone, in verbatim mode, so I could slurp in a working program, shift it over four spaces, and have it print out, er, verbatim. "
What am I missing, here?
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.