Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine

Re: Re: (tye)Re: Inline POD vs. EOF POD

by lachoy (Parson)
on Jul 10, 2001 at 01:01 UTC ( #95161=note: print w/ replies, xml ) Need Help??

in reply to Re: (tye)Re: Inline POD vs. EOF POD
in thread Inline POD vs. EOF POD

I'm intruiged by the potential literate programming aspect of POD (more info, see this excellent node) and, more generally, about being able to machine-generate metadata from documentation, as clemburg pointed out.

I prefer to keep information as close as possible to where I might generate it and where I might need it again -- the To Do list is the canonical example. I want to add items to my list wherever I'm programming (at the head of a subroutine, for instance) and then periodically generate all my to do items from all my code.

A natural extension of this is to keep the docs as close to the code as possible, but as has been pointed out in a number of objections here, there are real problems with this. The foremost is probably readability followed closely by, as you mention, organization.

I'm still not terribly comfortable with putting everything at the end, but I think that's what I'll probably stick with. Until something better comes along :-)

M-x auto-bs-mode

Comment on Re: Re: (tye)Re: Inline POD vs. EOF POD
Replies are listed 'Best First'.
Re: Re: Re: (tye)Re: Inline POD vs. EOF POD
by John M. Dlugosz (Monsignor) on Jul 10, 2001 at 01:43 UTC
    Hmm, reading the overview in that node, it seems that tangle can be implemented as a source filter, so that the LP file itself is directly shipped.

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (5)
As of 2015-11-28 12:12 GMT
Find Nodes?
    Voting Booth?

    What would be the most significant thing to happen if a rope (or wire) tied the Earth and the Moon together?

    Results (741 votes), past polls