Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Re^4: Section Dividers - What are your thoughts (POD antipattern)

by LanX (Cardinal)
on Jun 08, 2020 at 09:54 UTC ( #11117811=note: print w/replies, xml ) Need Help??


in reply to Re^3: Section Dividers - What are your thoughts (POD antipattern)
in thread Section Dividers - What are your thoughts

You mean Literate Programming and for clarity POD isn't!

It doesn't allow reordering of doc or code (tangle/weave)

But Perl has the power of sub-modules* and one could "weave" .pod files instead.

Cheers Rolf
(addicted to the Perl Programming Language :)
Wikisyntax for the Monastery

*) to structure code

  • Comment on Re^4: Section Dividers - What are your thoughts (POD antipattern)

Replies are listed 'Best First'.
Re^5: Section Dividers - What are your thoughts (POD antipattern)
by Anonymous Monk on Jun 08, 2020 at 11:16 UTC
    You mean Literate Programming and for clarity POD isn't!
    Sorry, my mistake. Yes, POD is isn't NOWEB. (I think that you would agree that embedding a literate programming system in /usr/bin/perl would complicate things too much.)

      > (I think that you would agree that embedding a literate programming system in /usr/bin/perl would complicate things too much.

      No, I disagree in this generality. But it depends what the goal is.

      I'm not sure if Knuth had the possibilities to use modules as alternatives back then. And he didn't know the necessities of CPAN (though CTAN was the source)

      Personally I like having some docs* close to code.

      That's why I once realized a solution to parse docs from sub modules to generate a .pod file.

      Not sure what LP can offer more here or if this even helps realizing it's main goal.

      Cheers Rolf
      (addicted to the Perl Programming Language :)
      Wikisyntax for the Monastery

      *) there are many different types of documenation, which need to be separated in this discussion here.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://11117811]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (6)
As of 2020-09-21 19:41 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    If at first I donít succeed, I Ö










    Results (127 votes). Check out past polls.

    Notices?