die & warn documentation error if last element of LIST is empty

[p5pRT]

Migrated from rt.perl.org#131203 (status was 'open')

Searchable as RT131203$

[p5pRT]

From msh210@gmail.com

Hi,

https://perldoc.perl.org/functions/die.html says "If the last element of
LIST does not end in a newline, the current script line number and input
line number (if any) are also printed, and a newline is supplied." It
should instead say "If the string thus to be printed does not end in a
newline, the current script line number and input line number (if any) are
also printed, and a newline is supplied.", since perl -e"die
qq[test$/],undef" does not append file and line information (tested in
Strawberry 5.24.0). (This same error appears in the docs for warn.)

Yours,

Michael Hamm

---

---

Flags​:
  category=docs
  severity=low

[p5pRT]

From @jkeenan

Thank you very much for this report. However, ...

The website perldoc.perl.org is not maintained by Perl 5 Porters. Hence, defective links on pages on that site should be reported to the website's maintainer; search for 'Site maintained by' on any page to learn how to contact that maintainer.

See the two programs attached, which illustrate the documentation about which you voiced concerns. The source code documentation in pod/perlfunc.pod appears to be correct.

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

[p5pRT]

From @jkeenan

131203-die-nl.pl

[p5pRT]

From @jkeenan

131203-die.pl

[p5pRT]

The RT System itself - Status changed from 'new' to 'open'

[p5pRT]

@jkeenan - Status changed from 'open' to 'rejected'

[p5pRT]

From msh210@gmail.com

On Tue, May 16, 2017 at 2​:44 AM, James E Keenan via RT <
perlbug-followup@​perl.org> wrote​:

The website perldoc.perl.org is not maintained by Perl 5 Porters. Hence,
defective links on pages on that site should be reported to the website's
maintainer; search for 'Site maintained by' on any page to learn how to
contact that maintainer.

See the two programs attached, which illustrate the documentation about
which you voiced concerns. The source code documentation in
pod/perlfunc.pod appears to be correct.

The test cases you attached don't seem to be relevant. This is​:

  die ( "test\n" , undef )

This seems to be a problem with the docs and not just their Web version.

Thanks,

--
Michael Hamm

[p5pRT]

@iabyn - Status changed from 'rejected' to 'open'

[p5pRT]

From @iabyn

On Wed, May 17, 2017 at 10​:53​:40PM +0300, Michael Hamm wrote​:

On Tue, May 16, 2017 at 2​:44 AM, James E Keenan via RT <
perlbug-followup@​perl.org> wrote​:

The website perldoc.perl.org is not maintained by Perl 5 Porters. Hence,
defective links on pages on that site should be reported to the website's
maintainer; search for 'Site maintained by' on any page to learn how to
contact that maintainer.

See the two programs attached, which illustrate the documentation about
which you voiced concerns. The source code documentation in
pod/perlfunc.pod appears to be correct.

The test cases you attached don't seem to be relevant. This is​:

die \( "test\\n" \, undef \)

This seems to be a problem with the docs and not just their Web version.

I agree that the docs for die are at fault. Similarly

  $ perl -we'die "foo\n"'
  foo
  $ perl -we'die "foo\n", ""'
  foo
  $

I'm marking the ticket as re-opened.

--
A power surge on the Bridge is rapidly and correctly diagnosed as a faulty
capacitor by the highly-trained and competent engineering staff.
  -- Things That Never Happen in "Star Trek" #9

[jkeenan]

From @iabyn

On Wed, May 17, 2017 at 10​:53​:40PM +0300, Michael Hamm wrote​:

This seems to be a problem with the docs and not just their Web version.

I agree that the docs for die are at fault. Similarly

$ perl -we'die "foo\n"' foo $ perl -we'die "foo\n", ""' foo $

I'm marking the ticket as re-opened.

[Unintentionally closed in RT-to-GH transition in October 2019; re-opening.]

The current documentation for perldoc -f die includes:

If the string exception does not end in a newline, the current
script line number and input line number (if any) and a newline
are appended to it. 

@iabyn, would you like to submit a pull request for the doc change? Thanks.

[iabyn]

The current entry for die appears to state the behaviour with line endings correctly. It was fixed by Zefram with v5.27.6-273-g52e58e7645