Skip Menu |

This queue is for tickets about the Getopt-Long CPAN distribution.

Report information
The Basics
Id: 55412
Status: resolved
Priority: 0/
Queue: Getopt-Long

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

Bug Information
Severity: Normal
Broken in: 2.37
Fixed in: (no value)



Subject: Documentation error
length|size|l name is "length", aliases are "size" and "l" is not a good exmaple, because l is an abbreviation of langth and this will run without "|l" too. You will get a problem if you extend e.g. the option left.
Subject: Re: [rt.cpan.org #55412] Documentation error
Date: Tue, 23 May 2017 18:12:53 -0400
To: bug-Getopt-Long [...] rt.cpan.org
From: "David H. Gutteridge" <dhgutteridge [...] sympatico.ca>
On Wed Mar 10, at 04:13:19 2010, STEFFENW@cpan.org wrote: Show quoted text
> length|size|l name is "length", aliases are "size" and "l" is not a > good exmaple, because l is an abbreviation of langth and this will run > without "|l" too. You will get a problem if you extend e.g. the option > left.
I don't think this is really a documentation error. In the quoted example, there won't be any problem, because "length" has been specifically aliased to "l". If "left" is added, "l" is still unambiguously aliased to "length". In fact, it's the opposite: one could have a problem if "left" was added without specifying it or "length" was explicitly aliased to "l". Auto-abbreviation behaviour is already generally well-documented in the POD, though a sentence could be added to clarify this consideration (or the example could be changed from "length" to "height" to align with the previous example under "Case and abbreviations"). Regards, Dave
ok