Hi,
It seems to me that few documents describe what to put in a documentation or
in which form. I haven't found any inteligent or complete description on
CPAN. There are a few heros that wrote some tips but looking at the new
modules coming into CPAN. I'd say we are lacking one "standard" document
[EMAIL PROTECTED] (Khemir Nadim) writes:
> It seems to me that few documents describe what to put in a documentation or
> in which form. I haven't found any inteligent or complete description on
> CPAN.
How to document a module:
1) Look at modules you think are good examples of documentation.
2) C
> -Original Message-
> From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]
> On Behalf Of Simon Cozens
> Sent: Monday, August 16, 2004 4:39 AM
> To: [EMAIL PROTECTED]
> Subject: Re: Where do people learn how to document a module?
>
> [EMAIL PROTECTED] (Khemir Nad
Hugh S. Myers wrote:
Good suggestions all. OTOH---I can't help but think that it wouldn't hurt to
have a few more documentation tools, for both old and new authors. I'm
working on a script using B::Deparse that will when done at least generate a
skeleton document framework for subs and globals.
Pod
On Mon, Aug 16, 2004 at 10:26:51AM -0400, Randy W. Sims ([EMAIL PROTECTED]) wrote:
> Pod::Coverage might be usefull. I think it provides a way to list all
> undocumented subs which in the case of the script you're talking about
> would be all non-private subs. Using it would guarantee that the po
TECTED]
> Cc: Hugh S. Myers; 'Simon Cozens'; [EMAIL PROTECTED]
> Subject: Re: Where do people learn how to document a module?
>
> On Mon, Aug 16, 2004 at 10:26:51AM -0400, Randy W. Sims (ml-
> [EMAIL PROTECTED]) wrote:
> > Pod::Coverage might be usefull. I think it pro
On Mon, Aug 16, 2004 at 10:06:37AM -0600, Hugh S. Myers ([EMAIL PROTECTED]) wrote:
> Excellent! Assuming some degree of 'act togetherness', when ready I'll post
> an article on PM incorporating both suggestions...
Note also that you have t/pod.t:
#!perl -T
use Test::More;
eval "use Test::Pod 1.1
# The following was supposedly scribed by
# Hugh S. Myers
# on Monday 16 August 2004 08:58 am:
> I'm
>working on a script using B::Deparse that will when done at least generate a
>skeleton document framework for subs and globals.
That would be convenient if it can detect where documentation alrea
others are doing about the common problem.
--hsm
> -Original Message-
> From: Eric Wilhelm [mailto:[EMAIL PROTECTED]
> Sent: Monday, August 16, 2004 3:32 PM
> To: [EMAIL PROTECTED]
> Subject: Re: Where do people learn how to document a module?
>
> # The following was
