develooper Front page | perl.perl5.porters | Postings from February 2018

[perl #132732] use if - behaviour does not match documentation

Thread Previous
From:
James E Keenan via RT
Date:
February 1, 2018 12:49
Subject:
[perl #132732] use if - behaviour does not match documentation
Message ID:
rt-4.0.24-408-1517489343-1956.132732-15-0@perl.org
On Tue, 30 Jan 2018 04:25:40 GMT, sisyphus wrote:
> 
> 
> -----Original Message-----
> From: James E Keenan via RT
> Sent: Tuesday, January 30, 2018 10:10 AM
> To: OtherRecipients of perl Ticket #132732:
> Cc: perl5-porters@perl.org
> Subject: [perl #132732] use if - behaviour does not match
> documentation
> 
> .....
> 
> >> Please review the new patch attached, 132732-
> >> 0001-if-module-clarify-documentation-and-test-more-thorou.patch.
> >>
> >
> > I plan to apply the patch on Thu, Feb 01 unless there is objection.
> 
> Jim,
> 
> That all looks pretty good to me, and tests fine.
> 
> The last paragraph in the "SEE ALSO" section of the POD (which pre-
> dates
> your rewrite) threw me for a few seconds. My perldoc utility renders
> it
> simply as:
> 
> provide can be used to select one of several possible modules to load,
> based on what version of Perl is running.
> 
> Probably not so confusing if you know that there's a module named
> "provide" - but I didn't know that, and it's not part of core.
> 
> Maybe something like:
> =~ s/L<provide>/The L<provide> module from CPAN/
> 
> Also, the end of the sentence ("based on what version of Perl is
> running")
> makes me grimace a bit, as do the replacements that I come up with -
> namely,
> "based on the version of Perl that is running" or just "based on the
> version
> of Perl".
> So I'm not going to make *any* suggestions about that.
> 
> Thanks for being thorough ... and for doing all the work.
> 
> Cheers,
>  Rob

Pushed to blead in 1654584e05038fee2cc4307f292f18e445d0e50f with some documentation touch-ups as suggested by Rob.

Thank you very much.


-- 
James E Keenan (jkeenan@cpan.org)

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

Thread Previous


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