Re: Pod at __END__

2007-06-08 Thread Joshua ben Jore
On 6/7/07, Eric Wilhelm <[EMAIL PROTECTED]> wrote: # from Joshua ben Jore # on Thursday 07 June 2007 05:14 pm: >On 6/7/07, Eric Wilhelm <[EMAIL PROTECTED]> wrote: >> I've never seen the benefit of pod after __END__. IMO, your code >> and docs should follow the same order/groupings. > >It has two

Re: Pod at __END__

2007-06-08 Thread Adrian Howard
On 8 Jun 2007, at 01:14, Joshua ben Jore wrote: On 6/7/07, Eric Wilhelm <[EMAIL PROTECTED]> wrote: I've never seen the benefit of pod after __END__. IMO, your code and docs should follow the same order/groupings. That, and you have to It has two benefits. Separating code from pod prevents

Re: podlifter

2007-06-08 Thread Andy Armstrong
On 8 Jun 2007, at 04:14, Eric Wilhelm wrote: Getting it interleaved back into the right spot without leaving a token behind would probably be difficult, particularly if an =head2 gets stuck in while out of line. (You would probably need tokens in both the code and the pod to do it right.) Ye

Re: Pod at end

2007-06-08 Thread Adrian Howard
On 8 Jun 2007, at 13:04, Andy Armstrong wrote: [snip] I can see the benefits of keeping a method and its documentation adjacent. Intuition would would pull me in that direction - but practice pulls me in the other direction. When I have my documentation head on I just want to see documentat

Re: Pod::Critic?

2007-06-08 Thread Andy Armstrong
On 8 Jun 2007, at 09:03, Piers Cawley wrote: Have we been round the 'use a folding editor then' route yet? I forget. Yes I think so :) I don't really want to change my POD writing habits though. My reasons for preferring POD at the end are just as valid /for me/ as someone else's reasons

Re: Pod at __END__

2007-06-08 Thread Andy Armstrong
On 8 Jun 2007, at 08:24, Adrian Howard wrote: If I have a whole bunch of public subroutines that I can have in a reasonable order for reading I'll inline the POD. I find it helps to have it nearby. That Knuth bloke and his literate programming wasn't completely nuts in my opinion :-) Excep

Re: Pod at end

2007-06-08 Thread Andy Armstrong
On 8 Jun 2007, at 07:09, chromatic wrote: Fiddling with the POD before I’m done is beyond pointless. I'm willing to bet that you write documentation as the last task before bundling a release too. That's also my style. Sometimes I write the POD as a storyboard of how the module's interf

Re: Pod::Critic?

2007-06-08 Thread Piers Cawley
On 07/06/07, Andy Armstrong <[EMAIL PROTECTED]> wrote: On 7 Jun 2007, at 23:16, Andy Lester wrote: > On Jun 7, 2007, at 5:13 PM, Andy Armstrong wrote: > >> So: Interleaved for the first draft, at the end for maintenance. > > To me, this is the same as saying "I turn off warnings and strict > when

Re: Pod::Critic?

2007-06-08 Thread Nadim Khemir
On Thursday 07 June 2007 12:54, David Cantrell wrote: > Nadim Khemir wrote: > > 'method docs have examples': I believe the examples should be tested. > > I have to disagree. And that would be your priviledge. If you have code in you POD and that code is not tested then you POD is not tested. Yo

Re: Pod::Critic?

2007-06-08 Thread Nadim Khemir
On Friday 08 June 2007 00:04, Matisse Enzer wrote: > I wonder how you all feel these days about the "put the pod at > the __END__" approach? I've been trying it for over a year now > and am not really sure its the best way to go (vs. having the pod > for each method right next to it.) I put the P