Re: Modules::Starter question

2005-08-17 Thread Adam Kennedy
Robert wrote: I am creating my first module (finally) and I was told a while ago to use Module::Starter. Which I did. I am fine there. When I look at the code generated I see that all the POD stuff is inline while I prefer to see POD stuff at the end. Is the inline POD the current preferred way?

Re: Inline POD vs not (was Re: Modules::Starter question)

2005-08-16 Thread Dave Cross
On Tue, Aug 16, 2005 at 10:07:20AM +0100, David Cantrell wrote: > Michael G Schwern wrote: > > >* Private docs (=begin/end private) allow you to document private and > >public > > functions using the same style. > > Ooh, I didn't know about that! What revision of perl (or rather, > perldoc) d

Re: Inline POD vs not (was Re: Modules::Starter question)

2005-08-16 Thread David Cantrell
Michael G Schwern wrote: On Fri, Aug 05, 2005 at 11:32:45AM -0400, Robert wrote: Is the inline POD the current preferred way? That really depends on who you ask. Me? I prefer it. Its totally a matter of style. Pros: * Keeps the docs close to the code so you're more likely to keep the docs u

Re: Modules::Starter question

2005-08-09 Thread Robert
Dave Cross wrote: On Fri, Aug 05, 2005 at 11:32:45AM -0400, Robert wrote: I am creating my first module (finally) and I was told a while ago to use Module::Starter. Which I did. I am fine there. When I look at the code generated I see that all the POD stuff is inline while I prefer to see POD s

Re: Inline POD vs not (was Re: Modules::Starter question)

2005-08-08 Thread Ivan Tubert-Brohman
David Golden wrote: As a vim user, I found it helpful to edit my perl.vim syntax file like so: " Use only the bare minimum of rules - if exists("perl_fold") + if exists("perl_fold_pod") syn region perlPOD start="^=[a-z]" end="^=cut" fold else syn region perlPOD start="^=[a-z]" end="^

Re: Inline POD vs not (was Re: Modules::Starter question)

2005-08-08 Thread David Golden
Ivan Tubert-Brohman wrote: * The code gets "lost" among the documentation, as often you have more documentation than code. Syntax highlighting reduces the problem, but the POD still takes half the screen if you have short subs. Another option would be to dust the code folding features of my ed

Re: Modules::Starter question

2005-08-06 Thread Robert
Thanks for the answers. Robert

Re: Modules::Starter question

2005-08-06 Thread Dave Cross
On Fri, Aug 05, 2005 at 11:32:45AM -0400, Robert wrote: > I am creating my first module (finally) and I was told a while ago to > use Module::Starter. Which I did. I am fine there. When I look at the > code generated I see that all the POD stuff is inline while I prefer > to see POD stuff at the en

Re: Inline POD vs not (was Re: Modules::Starter question)

2005-08-06 Thread Ivan Tubert-Brohman
Michael G Schwern wrote: On Fri, Aug 05, 2005 at 11:32:45AM -0400, Robert wrote: Is the inline POD the current preferred way? That really depends on who you ask. Me? I prefer it. Its totally a matter of style. Pros: * Keeps the docs close to the code so you're more likely to keep the d

Re: Modules::Starter question

2005-08-06 Thread Tels
-BEGIN PGP SIGNED MESSAGE- Moin, On Friday 05 August 2005 17:32, Robert wrote: > I am creating my first module (finally) and I was told a while ago to > use Module::Starter. Which I did. I am fine there. When I look at the > code generated I see that all the POD stuff is inline while I pr

Inline POD vs not (was Re: Modules::Starter question)

2005-08-06 Thread Michael G Schwern
On Fri, Aug 05, 2005 at 11:32:45AM -0400, Robert wrote: > Is the inline POD the current preferred way? That really depends on who you ask. Me? I prefer it. Its totally a matter of style. Pros: * Keeps the docs close to the code so you're more likely to keep the docs up to date. * Docs tak