develooper Front page | perl.perl5.porters | Postings from August 2019

Re: [perl #134365] [PATCH] Typo in perlsub.pod

Thread Previous | Thread Next
From:
Karl Williamson
Date:
August 16, 2019 17:04
Subject:
Re: [perl #134365] [PATCH] Typo in perlsub.pod
Message ID:
621c1989-59dd-593b-5e4b-da3f085a9042@khwilliamson.com
On 8/16/19 3:55 AM, Valeriy Kireev wrote:
> I didn't know about "IFF" abbreviation. So, I suppose, this 
> misunderstanding is my mistake, thus there is no need to clean up code 
> base of IFFs.
> 
> On 8/15/19 10:45 PM, James E Keenan via RT wrote:
>> On Thu, 15 Aug 2019 16:31:06 GMT, grinnz@gmail.com wrote:
>>> On Thu, 15 Aug 2019 09:23:33 -0700, jkeenan wrote:
>>>> On Thu, 15 Aug 2019 16:02:45 GMT, Valeriy.Kireev@Tune-IT.Ru wrote:
>>>>> This is a bug report for perl from Valeriy.Kireev@Tune-IT.Ru,
>>>>> generated with the help of perlbug 1.41 running under perl 5.31.3.
>>>>>
>>>>>
>>>>> -----------------------------------------------------------------
>>>>> [Please describe your issue here]
>>>>> There is small typo in pod/perlsub.pod, "IIF" used instead of "if".
>>>>> The patch
>>>>> fixes it.
>>>>>
>>>>
>>>> There are places in the Perl 5 core distribution (and elsewhere in the
>>>> tech world) where the string "IFF" means "if and only if".
>>>>
>>>> Could this be one of those places?  If so, then we would not apply the
>>>> patch.
>>>>
>>>> Thank you very much.
>>>
>>> Yes, I think this is correct.
>>
>> Okay, given that at least one user found the documentation confusing, 
>> and given the fact that I had to ack the repository to locate other 
>> instances of 'IFF' to confirm my hunch, then I think we can conclude 
>> that the documentation is sub-optimal ... even though it's been there 
>> since perl-5.4 in 1997.

I agree.  I have, BTW, never seen iff expressed in caps before.  Since 
my undergrad degree is in mathematics, it would be just part of the text 
to me without slowing me down when perusing text that contains it.  But, 
I would have to stop and think about IFF.  So I think it's worth changing.
>>
>> The longer I stare at it, the more I feel I don't know what the 'else 
>> "foo"' part means.
>>
>> If I knew what 'else "foo"' meant, I'd work that into a rewording 
>> something like this:
>>
>> #####
>> foo;        # if and only if sub foo has been predeclared,
>>              # then this is like foo() above
>>              # otherwise, _______
>> #####
>>
> 

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About