Re: pod checker that finds missing internal links?

On Sat, Jan 28, 2012 at 03:38:48PM +0100, Marek Rouchal wrote:
> podchecker _does_ detect wrong internal links. If you 
> put any of the following links in the POD you quoted 
> below, podchecker (as of Pod-Parser-1.38 and higher) 
> will flag it as an error:
> 
> L</"open FILEHANDLE,MODE,EXPRESSION">
> L<"open FILEHANDLE,MODE,EXPRESSION">
> L</open FILEHANDLE,MODE,EXPRESSION>

I currently have perl 5.10.1 with Pod-Parser-1.37, I'll retest
with something more recent as soon as I have it.

> It is true that L</open> will work OK, because perlfunc
> (at least at the time when I wrote podchecker) contained
> many L</function> although the actual item was
> 
> =item function ARGUMENTS
> 
> and I did not want to flag dozens of errors for those.
> In other words: if the =item text matches /(\S+)\s+\S/
> Then $1 is also regarded as a valid reference for L<...>

I think that it is wrong, because there won't be an anchor
created with that name.

Also in all the files I read about Pod, it was nowhere said
that the link could be shortened, and instead, the link
part of L<...> was always clearly described.

> If you think that there should be something changed in
> podchecker, then please provide a complete POD example,
> the podchecker output and a statement on what should
> be changed and why.

I can only bring the result of the podchecker I have. On


=head1 aaa b

L</aaa>


The result is OK.  But the corresponding HTML generated by pod2html is

<h1><a name="aaa_b">aaa b</a></h1>
<p><a href="#aaa">aaa</a></p>


I think that podchecker should tel something here.

Also Pod::Simple should show an error too, in my opinion.

-- 
Pat