I wonder if the same functionality could be or should be provided for standard modules too? What about the general case of CPAN?

It would be very cool if there were some way to extract such information, but to stay realistic, that won't work until Perl has function/method signatures.

Currently much documentation actually duplicates the argument passing code in some way 


=item C<foo($bar, $count)>

Frobs the object by doing C<$bar> at least C<$count> times

=cut

sub foo {
   my ($self, $bar, $count) = @_;
}

[download]

This duplication is mostly done in a non-standard way, and as thus really hard to automatically distract.

I don't think that you'll have overwhelming success with convincing CPAN authors on a standard documentation format. The only way to win is to enable function and method signatures. By hacking them into bleadperl, or by helping Perl 6 development.

In reply to Re: Calltips for Padre by moritz
in thread Calltips for Padre by szabgab

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.