Front page | perl.perl5.porters |
Postings from January 2005
Re: perlpodtut II
Thread Previous
|
Thread Next
From:
David Landgren
Date:
January 3, 2005 15:15
Subject:
Re: perlpodtut II
Message ID:
41D9D201.2000108@landgren.net
Juerd wrote:
> Attached is the revised version of perlpodtut, based on your well
> appreciated feedback. The second attachment is the diff with the
> previous version.
[...]
> ------------------------------------------------------------------------
>
> =head1 NAME
>
> perlpodtut - Plain Old Documentation in 5 minutes
>
> =head1 DESCRIPTION
>
> This short tutorial will teach you how to write documentation with POD. POD
> stands for Plain Old Documentation and is the formatting language that the
POD stands for Plain Old Documentation
> official Perl documentation and CPAN modules use. Several translators exist
> for it, which can turn POD into manpages, HTML, LaTeX, RTF, etc.
>
> =head2 Documentation is important
>
> We all know that, and everyone knows why. I'll skip this section because any
> detailed discussion of why documentation is important would break my promise
> that you can learn to document in five minutes.
>
> =head2 Documentation in Perl
>
> Perl source code can contain documentation in POD format. POD stands for Plain
> Old Documentation. You can either mix POD with code, put the POD at the
> beginning of the file or put the POD at the end of the file. This
POD stands for Plain Old Documentation
Did you mean to repeat yourself? I would tend to favour ditching the
second occurrence.
"You can either mix POD with code"... I know what you mean, but I think
"intersperse" or "intermingle" describe the effect more clearly.
Tightening the prose: "beginning of the file or put the POD at the end
of the file" -> "beginning of the file or at the end".
David
Thread Previous
|
Thread Next