Stack Overflow
Stack Overflow

Questions tagged [perl-pod]

Plain Old Documentation format. Pod is a simple-to-use markup language used for writing documentation for Perl, Perl programs, and Perl modules.

perlpod

63 questions
1
vote
0 answers

How to make podlinkcheck not complain about URLs with a fragment

I have a Perl module with a L<...> link like this: =head1 ... See L. =cut 1; When I run podlinkcheck (version 15) on it, it complains: themodule.pm:3:5: no module/program/pod…
Robert
  • 7,394
  • 40
  • 45
  • 64
1
vote
1 answer

Why does PodSpelling complain about an ignored word if it's part of a file name?

PodSpelling (run via Perlcritic) complains about "html" even though I've added this to the stopwords: =for stopwords html =head2 some function Generates an index.html page. =cut This gets: robert@saaz:~$ perlcritic --brutal test.pl | grep…
Robert
  • 7,394
  • 40
  • 45
  • 64
1
vote
2 answers

Why won't this regex remove final whitespace from Pod::Usage text?

I am working on a module that relies on Pod::Usage to parse the calling script's POD and then send usage, help, and man text to a scalar variable. I needed to remove the final whitespace from that text, so I used a simple regex that I thought would…
FMc
  • 41,963
  • 13
  • 79
  • 132
1
vote
2 answers

How to make a Pod link from a module to a script within the same distribution?

Consider this module App::TimeTracker. If you click on the tracker link in the SYNOPSIS section you end up here whereas you should have ended up here. The Pod source code responsible for the behavior is given here, which shows that the following Pod…
Håkon Hægland
  • 39,012
  • 21
  • 81
  • 174
1
vote
1 answer

Abstract classes and Pod::Coverage

I've recently started to try to use Dist::Zilla for maintaining Path::Class. I added the [PodCoverageTests] plugin, and it's reporting some failures in the Path::Class::Entity class, which is the abstract base class for Path::Class::File and…
Ken Williams
  • 22,756
  • 10
  • 85
  • 147
1
vote
2 answers

When are blank lines needed in Perl POD documentation

I have noticed that a lot of Pod has blank lines between the lines such as code =head1 DESCRIPTION text Are these blank lines strictly needed, do specific parsers get upset if it is missing. The description for cut in perlpod helps a…
justintime
  • 3,601
  • 4
  • 22
  • 37
1
vote
2 answers

Pod::Usage not working correctly

I have: my $man = 0; my $help = 0; ## Parse options and print usage if there is a syntax error, ## or if usage was explicitly requested. GetOptions('help|?' => \$help, man => \$man) or pod2usage(2); pod2usage(1) if $help; pod2usage(-verbose => 2) if…
MrDuk
  • 16,578
  • 18
  • 74
  • 133
1
vote
1 answer

Checking for missed empty lines in POD

I use Dist::Zilla and a bunch of plugins to check my pod, including syntax, links, coverage etc. One really annoying POD mistake that I keep repeating is to forget to add an extra line after a =headX; for example, I just created a module with pod…
Nate Glenn
  • 6,455
  • 8
  • 52
  • 95
1
vote
3 answers

Perl program to print POD when wrong arguments are passed in

How can I get a perl program to print the POD contents when an incorrect argument or number of arguments are passed in?
Dave
  • 4,184
  • 8
  • 40
  • 46
0
votes
2 answers

Using asterisk in pod item as text

I'm writing my perl documentation in POD format my problem is, I want to have an item label simply called * I tried =item * , =item S<*> , =item Z<>* and =item E<42> all approaches are interpreted as bullets, but I want the asterisk interpreted as…
Hachi
  • 3,237
  • 1
  • 21
  • 29
0
votes
3 answers

perlpod: missing text issue

I'm having a issue where pod2usage is missing text, and I have tried to fix it by: converting newlines rewriting it checking it with podchecker but none of these things help to resolve or hint to my problem output of podchecker: YaTC.pod pod…
linuxrules94
  • 185
  • 3
  • 14
0
votes
1 answer

How (if at all) can I use Perl POD documentation in a shell script?

I wonder: In Perl POD is recognized partially by the Perl parser, and there is the __END__ keyword to stop Perl parsing. If I want to write POD in a shell script (maybe at the end of the script), can that be done, and if so: How?
U. Windl
  • 3,480
  • 26
  • 54
0
votes
0 answers

perldoc: 'ŷ' output as 'X' with "=encoding utf8"

When writing POD documentation, I realized that Unicode character ŷ became X on output. Input: =pod =encoding utf8 =over =item I (ŷ(t)) The value predicted for time I. =back Output in PuTTY: Input in Emacs: Version of perldoc being…
U. Windl
  • 3,480
  • 26
  • 54
0
votes
1 answer

How do I add multiple PODs to the end of my perl script?

I was working with a tutorial found in the perl documentation about how to use Getopt::Long in a script. In there it shows how to add documentation using Pod::Usage rather then having to type everything out a subroutine or something. Anyhow in the…
AtomicPorkchop
  • 2,625
  • 5
  • 36
  • 55
0
votes
1 answer

Equivalent for Dancer of Mojolicious Mojolicious::Plugin::PODRenderer?

I would like to generate documentation in a Dancer application in the same way that Mojolicious does with Mojolicious::Plugin::PODRenderer, I mean in the browser, under the /perldoc path. Does somebody knows a module that can help? I found no…
smonff
  • 3,399
  • 3
  • 36
  • 46
1 2 3
4
5