summaryrefslogtreecommitdiff
path: root/pod/perlpod.pod
diff options
context:
space:
mode:
authorJames E Keenan <jkeenan@cpan.org>2013-07-13 02:59:22 +0200
committerJames E Keenan <jkeenan@cpan.org>2013-07-13 02:59:22 +0200
commit13d0d101a48a328c651a6ca3c89e392bc65f9e1f (patch)
tree2e4a0c5a76208db60bfccc8d6568eaedd8390d8c /pod/perlpod.pod
parentbca8f980420acdca62da941e2d02a8a51ee7e57a (diff)
downloadperl-13d0d101a48a328c651a6ca3c89e392bc65f9e1f.tar.gz
POD inside of a function call is inadvisable.
Documentation suggestions based largely on suggestions by Aaron J Trevena and Brad Gilbert. For: RT #68706
Diffstat (limited to 'pod/perlpod.pod')
-rw-r--r--pod/perlpod.pod18
1 files changed, 11 insertions, 7 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod
index 9ea7935d34..7333fcc013 100644
--- a/pod/perlpod.pod
+++ b/pod/perlpod.pod
@@ -628,13 +628,17 @@ B<pod2fm>. Various others are available in CPAN.
=head2 Embedding Pods in Perl Modules
X<POD, embedding>
-You can embed Pod documentation in your Perl modules and scripts.
-Start your documentation with an empty line, a "=head1" command at the
-beginning, and end it with a "=cut" command and an empty line. Perl
-will ignore the Pod text. See any of the supplied library modules for
-examples. If you're going to put your Pod at the end of the file, and
-you're using an __END__ or __DATA__ cut mark, make sure to put an
-empty line there before the first Pod command.
+You can embed Pod documentation in your Perl modules and scripts. Start
+your documentation with an empty line, a "=head1" command at the
+beginning, and end it with a "=cut" command and an empty line. The
+B<perl> executable will ignore the Pod text. You can place a Pod
+statement where B<perl> expects the beginning of a new statement, but
+not within a statement, as that would result in an error. See any of
+the supplied library modules for examples.
+
+If you're going to put your Pod at the end of the file, and you're using
+an C<__END__> or C<__DATA__> cut mark, make sure to put an empty line there
+before the first Pod command.
__END__