1. It's difficult to fold...outline-minor-mode assigns outline-levels and "=head1" and "sub {" are toplevel, "=head2" second level and so on. Ilya wants to know the "common sense" befor changing this.

2. It's not DRY, e.g. I still have to repeat the method name

3. all these necessary empty lines makes it voluminous

4. (personal side note) it doesn't support introspection a la "docstring"

> A small improvement might be to put all Pod before METHODS and after SEE ALSO in a separate file

yeah I already had this idea to extract documentation in comments and to generate the POD.

e.g. something like

sub func {
  my $DOC="yadda yadda"
  ...code
}

[download]

or 

sub func :DOC(yadda yadda) {
  ...code
}

[download]

would fold nicely in every editor, allow introspection and could be parsed to generate the POD.

(but it's always smarter to ask before risking to reinvent the wheel :)

Cheers Rolf

In reply to Re^2: [literate programming] How to mix POD with code? And how to fold this? by LanX
in thread [literate programming] How to mix POD with code? And how to fold this? by LanX

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.