Perl / perl5

🐪 The Perl programming language
https://dev.perl.org/perl5/
Other
1.91k stars 542 forks source link

Perl 5.6.0 documentation glitch #2805

Closed p5pRT closed 20 years ago

p5pRT commented 23 years ago

Migrated from rt.perl.org#4601 (status was 'resolved')

Searchable as RT4601$

p5pRT commented 23 years ago

From somos@grail.cba.csuohio.edu

This is not a bug\, just a garden variety documentation glitch. I have downloaded Perl 5.6.0 and found in the file "Porting/Contract" the line :

">From time to time\, a script\, module\, or set of modules (hereafter referred"

which I have embedded in double quotes to avoid the e-mail glitch which was originally responsible for prepending the line with ">" because it began with the word "From". This is a common problem when e-mailing text files which have not been protected from mailer transformations. I am not sure about the line in the file "pod/perltoot.pod" which looks like this :

"Z\<>From the C++ perspective\, all methods in Perl are virtual."

since I don't know the purpose of the "Z\<>" construct in Perl pod format. Shalom\, Michael

p5pRT commented 23 years ago

From @rspier

"MS" == Michael Somos \somos@&#8203;grail\.cba\.csuohio\.edu writes​: MS> ">From time to time\, a script\, module\, or set of modules MS> (hereafter referred"

MS> "pod/perltoot.pod" which looks like this : MS> "Z\<>From the C++ perspective\, all methods in Perl are virtual."

  Z\<> A zero-width character

I think that both of these are unnecessary - yes\, the file may be changed slightly when it gets emailed around\, but I'm pretty sure the recieving MUA should be undoing this before display.

There are lots of other examples of /^From/ in the code\, so here's a patch for the above two. I didn't find any other examples of this in the tree.

Inline Patch ```diff --- Porting/Contract.orig Mon Nov 6 09:32:41 2000 +++ Porting/Contract Mon Nov 6 09:32:51 2000 @@ -19,7 +19,7 @@ We recognize that the Perl core, defined as the software distributed with the heart of Perl itself, is a joint project on the part of all of us. ->From time to time, a script, module, or set of modules (hereafter referred +From time to time, a script, module, or set of modules (hereafter referred to simply as a "module") will prove so widely useful and/or so integral to the correct functioning of Perl itself that it should be distributed with Perl core. This should never be done without the author's explicit --- pod/perltoot.pod.orig Mon Nov 6 09:34:07 2000 +++ pod/perltoot.pod Mon Nov 6 09:34:47 2000 @@ -1727,7 +1727,7 @@ call a class method (one expecting a string argument) on an object (one expecting a reference), or vice versa. -Z<>From the C++ perspective, all methods in Perl are virtual. +From the C++ perspective, all methods in Perl are virtual. This, by the way, is why they are never checked for function prototypes in the argument list as regular builtin and user-defined functions can be ```