diff options
author | Abhijit Menon-Sen <ams@wiw.org> | 2001-11-16 12:11:14 +0000 |
---|---|---|
committer | Abhijit Menon-Sen <ams@wiw.org> | 2001-11-16 12:11:14 +0000 |
commit | 210b36aa2e9e009554be8970c3315c2658c0384f (patch) | |
tree | 71bb13e291837569d86a3f2f5c17515ccc1b9610 /pod/perlpod.pod | |
parent | d7ceb7fc1159206a67f149394fc7aa55f6b4f7dd (diff) | |
download | perl-210b36aa2e9e009554be8970c3315c2658c0384f.tar.gz |
[PATCH] Doc spellcheck + podcheck
From: Autrijus Tang <autrijus@egb.elixus.org>
Date: Thu, 15 Nov 2001 22:49:05 -0800
Message-Id: <20011116064905.GA44092@egb.elixus.org>
Subject: [PATCH] podcheck+spellcheck, the rest of the story
From: Autrijus Tang <autrijus@egb.elixus.org>
Date: Fri, 16 Nov 2001 00:42:20 -0800
Message-Id: <20011116084220.GA44295@egb.elixus.org>
Subject: Re: [PATCH] podcheck+spellcheck, the rest of the story
From: Nicholas Clark <nick@ccl4.org>
Date: Fri, 16 Nov 2001 10:32:01 +0000
Message-Id: <20011116103200.F62891@plum.flirble.org>
(Applied after suitable de-mangling.)
p4raw-id: //depot/perl@13041
Diffstat (limited to 'pod/perlpod.pod')
-rw-r--r-- | pod/perlpod.pod | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod index 91cc81ac84..80c9ba134a 100644 --- a/pod/perlpod.pod +++ b/pod/perlpod.pod @@ -173,21 +173,21 @@ usually used just when you want to start a Pod block with an ordinary paragraph or a verbatim paragraph. For example: =item stuff() - + This function does stuff. - + =cut - + sub stuff { ... } - + =pod - + Remember to check its return value, as in: - - stuff() || die "Couldn't do stufF!"; - + + stuff() || die "Couldn't do stuff!"; + =cut =item C<=begin I<formatname>> @@ -208,10 +208,10 @@ is meant for formatters that understand the special format called I<formatname>. For example, =begin html - + <hr> <img src="thang.png"> <p> This is a raw HTML paragraph </p> - + =end html The command "=for I<formatname> I<text...>" @@ -613,7 +613,7 @@ wish to work around. =item * If you're more familiar with writing in HTML than with writing in Pod, you -can try your hand at writing documentation in simple HTML, and coverting +can try your hand at writing documentation in simple HTML, and converting it to Pod with the experimental L<Pod::HTML2Pod|Pod::HTML2Pod> module, (available in CPAN), and looking at the resulting code. The experimental L<Pod::PXML|Pod::PXML> module in CPAN might also be useful. @@ -626,7 +626,7 @@ line. Having something like this: # - - - - - - - - - - - - =item $firecracker->boom() - + This noisily detonates the firecracker object. =cut sub boom { @@ -638,13 +638,13 @@ at all. Instead, have it like this: # - - - - - - - - - - - - - + =item $firecracker->boom() - + This noisily detonates the firecracker object. - + =cut - + sub boom { ... |