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

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

Thread Previous | Thread Next
From:
James E Keenan via RT
Date:
August 15, 2019 19:45
Subject:
[perl #134365] [PATCH] Typo in perlsub.pod
Message ID:
rt-4.0.24-791-1565898319-1121.134365-15-0@perl.org
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.

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, _______
#####
-- 
James E Keenan (jkeenan@cpan.org)

---
via perlbug:  queue: perl5 status: open
https://rt.perl.org/Ticket/Display.html?id=134365

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