Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

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

by Anonymous Monk
on Jun 08, 2020 at 09:34 UTC ( #11117810=note: print w/replies, xml ) Need Help??


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

The documentation will show up in the same order like programmed and must stay at this chronological position.
This might make a case for literal programming (write code and documentation in the order one would want to read it, but reorder the code chunks in the order it should run in), but that comes with its own bag of problems and requires trade-offs that one might consider unacceptable.
  • Comment on Re^3: Section Dividers - What are your thoughts (POD antipattern)

Replies are listed 'Best First'.
Re^4: Section Dividers - What are your thoughts (POD antipattern)
by LanX (Cardinal) on Jun 08, 2020 at 09:54 UTC
    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

      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://11117810]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others chanting in the Monastery: (4)
As of 2020-12-01 18:36 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    How often do you use taint mode?





    Results (18 votes). Check out past polls.

    Notices?