G'day fkento,

The short answer is that these represent author errors.

Take a look at perlpod. Near the start you'll see a description of both an "Ordinary Paragraph" and a "Verbatim Paragraph". Note that the former allows formatting codes but the latter does not.

About halfway down that page, you'll find "Formatting Codes". Here you'll see an explanation of "C<code> -- code text", "L<name> -- a hyperlink", and many others.

Now look at the "source code for Net::Amazon::S3::Client", you'll see at both lines 153 and 161: 

        # returns a L<Net::Amazon::S3::Client::Bucket> object

[download]

Because those lines, and the lines around them, start with whitespace, they form a verbatim paragraph. Formatting codes are not allowed in verbatim paragraphs, so the "L<...>" is rendered exactly as seen.

I'm not going to go hunting for examples of C<0>. Look in the source code of wherever you saw this: I expect you'll find the same "formatting code within a verbatim paragraph" error.

"When reading documentation on metacpan.org, I frequently see stuff like this:"

I've read a lot of CPAN documentation and I can't remember seeing this in the past (certainly not frequently). I did note that the "Net-Amazon-S3 distribution" has many modules with the same error. I've never used any modules in the Net::Amazon:: namespace, so I don't know how widespread this problem is. I'd be interested to know if you've encountered this issue with other, unrelated modules.

— Ken

In reply to Re: Unknown tags in documentation by kcott
in thread Unknown tags in documentation by fkento

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.