Skip Menu |

This queue is for tickets about the version CPAN distribution.

Report information
The Basics
Id: 107114
Status: resolved
Priority: 0/
Queue: version

People
Owner: Nobody in particular
Requestors: VDB [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: 0.9912
Fixed in: (no value)



Subject: Documentation is confusing #2
https://metacpan.org/pod/version::Internals#WHAT-IS-A-VERSION Show quoted text
> WHAT IS A VERSION? > > For the purposes of this module, <...skipped...> > > There are actually two distinct kinds of version objects: > > Decimal Versions > ^^^ LINK TARGET ^^^ > > Any version which "looks like a number", see "Decimal Versions". > ^^^^^^ LINK ^^^^^^ > This also includes versions with a single decimal point and a single > embedded underscore, see "Alpha Versions", even though these must be > quoted to preserve the underscore formatting.
"Decimal Versions" (in phrase "see "Decimal Versions") is a link pointing to the section, containing the link.
On 2015-09-15 15:49:59, VDB wrote: Show quoted text
> https://metacpan.org/pod/version::Internals#WHAT-IS-A-VERSION >
> > WHAT IS A VERSION? > > > > For the purposes of this module, <...skipped...> > > > > There are actually two distinct kinds of version objects: > > > > Decimal Versions > > ^^^ LINK TARGET ^^^ > > > > Any version which "looks like a number", see "Decimal Versions". > > ^^^^^^ LINK ^^^^^^ > > This also includes versions with a single decimal point and a single
> > > embedded underscore, see "Alpha Versions", even though these must
> > be > > quoted to preserve the underscore formatting.
> > "Decimal Versions" (in phrase "see "Decimal Versions") is a link > pointing to the section, containing the link.
The author meant the link to go to a real section also named "Decimal Versions" a few lines later: https://metacpan.org/pod/version::Internals#Decimal-Versions1 Unfortunately, the Pod specification is vague about the right behavior of linking to same-named sections. perlpodspec.pod says: This specification does not specify what behavior should be in the case of a given document having several things all seeming to produce the same section identifier (A section may be a =head or =item here) Different renderers behave differently here. tkpod prefers to link to =head sections first and would create the "correct" link. The metacpan pod2html renderer seems to choose the first such section, even if it is linking to the same section (which could be constructed as a bug, or at least a behavior which could be done better).
On Fri Sep 18 03:00:06 2015, SREZIC wrote: Show quoted text
> On 2015-09-15 15:49:59, VDB wrote:
> > > Decimal Versions > > > ^^^ LINK TARGET ^^^ > > > > > > Any version which "looks like a number", see "Decimal Versions". > > > ^^^^^^ LINK ^^^^^
Apparently resolved in 0.9913 by varying the capitalization of the Section name from the li name