----- Original Message -----

From: Joe Rizza

To: dadadev@PROTECTED

Sent: Sunday, July 23, 2006 8:58 AM

Subject: [dadadev] Re: Idea: Take out the Config.pm embedded documentation

I have mixed feelings. It's great to have some comments in the code, but because it is somewhat distracting to have the "pod" tags in the file, I typically have the generated HTML sitting on the side when I am editing the file. I can see the advantage to putting the "pod" tags in the file, but when you generate a separate document, it should be written differently from the comments in the code. Would be nice if there was a way to have the best of both worlds, without the extra work.

On 23 Jul 2006 00:36:01 -0000, Dada Mail (Justin Simoni) <dada@PROTECTED> wrote:

Hey guys/gals, I have an idea, I thought I'd first ask you all for an
opinion about:

Currently, the Config.pm file has embedded documentation, that gets
run through a translator, to make pretty HTML files like this:

        http://mojo.skazat.com/support/documentation/Config.pm.html

Here's more information on how/what the embedded docs are/work:

        http://www.ayni.com/perldoc/perl5.8.0/pod/perlpod.html

Some people have voiced that the embedded documentation actually
makes reading the Config.pm file *harder*, since it's difficult to
pick out sometimes, what variable it is you need to change, and what
is just the *example* of how you change the variable.

It may be worth while to, before I distribute Dada Mail, strip out
this embedded documentation, to make the Config.pm file a little less
busy. I could leave small comments here and there to keep some sort
of organization in the file itself, but scrubbing everything else,
except the actual variables, could lead to a easier-to-configure
program.


Any comments on this idea? If it's a horrible idea, please let me
know :)

Cheers, and thanks for all the comments on the boards and bugs file
recently,

--
Justin Simoni

.: Dada Mail "Write Once - Distribute Everywhere" Email Communication
Software

url:   http://mojo.skazat.com
aolim: leaddadaist






--

Post:
    <mailto:dadadev@PROTECTED>

Unsubscribe:
     < http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/>

List Information:
     <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev >

Archive:
         <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/dadadev>

--
-Joe

joe.rizza@PROTECTED
joe.rizza@PROTECTED
joe@PROTECTED
http://www.scubajoe.net/

Post:
mailto:dadadev@PROTECTED

Unsubscribe:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/

List Information:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev

Archive:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/dadadev

Post:
mailto:dadadev@PROTECTED

Unsubscribe:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/[list]/

List Information:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/[list]

Archive:
http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/[list]