Re: Idea: Take out the Config.pm embedded documentation

 
From: "Joe Rizza" <joe@PROTECTED>
Date: July 23rd 2006
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/[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]

  • This mailing list is a public mailing list - anyone may join or leave, at any time.
  • This mailing list is a group discussion list (unmoderated)
  • Start a new thread, email: dadadev@dadamailproject.com

This is the developer discussion mailing list for Dada Mail.

If you are just looking for support Dada Mail, consult the message boards at:

https://forum.dadamailproject.com

Documentation for Dada Mail:

https://dadamailproject.com/d

Specifically, see the Error FAQ:

https://dadamailproject.com/d/FAQ-errors.pod.html

To post to this list, send a message to:

mailto:dadadev@dadamailproject.com

All subscribers of this list may post to the list itself.

Topics that are welcome:

  • Constructive critiques on the program (I like, "x", but, "y" needs some work - here's an idea on how to make this better...)
  • Bug/Error reports
  • Bug fixes
  • Request For Comments on any changes to the program
  • Help customizing Dada Mail for your own needs
  • Patches
  • Language Translations
  • Support Documentation/Doc editing, FAQ's, etc.
  • Discussion of any changes that you would like to be committed to the next version of Dada Mail -

Dada Mail is on Github:

https://github.com/justingit/dada-mail/

If you would like to fork, branch, send over PRs, open up issues, etc.

Privacy Policy:

This Privacy Policy is for this mailing list, and this mailing list only.

Email addresses collection through this mailing list are used explicitly to work within this email discussion list.

We only collect email addresses through our Closed-Loop Opt-In system.

We don't use your email address for any other purpose.

We won't be sharing your email address with any other entity.

Unsubscription can be done at any time. Please contact us at: justin@dadamailproject.com for any help regarding your subscription, including removal from the mailing list.

All mailing list messages sent from us will include a subscription removal link, which will allow you to remove yourself from this mailing list automatically, and permanently.

All consent to use your email address for any other purpose stated at the time of the mailing list subscription will also be revoked upon mailing list removal.