Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

POD Formatting Codes (F<>, C<>, L<>, etc.) render incorrectly for some modules #8

Open
gsullivan opened this issue Sep 2, 2010 · 3 comments

Comments

@gsullivan
Copy link

Starting with Perl version 5.10.1, there is a problem with how the POD
Formatting Codes get converted to HTML.

For example, the ExtUtils::MakeMaker core module has problems with the
following POD Formatting Codes:
C<>
E<>
F<>
I<>
L<>

The page http://perldoc.perl.org/5.10.1/ExtUtils/MakeMaker.html#make-test
incorrectly renders as:

MakeMaker checks for the existence of a file named F in the

The previous Perl version (5.10.0) renders properly
(http://perldoc.perl.org/5.10.0/ExtUtils/MakeMaker.html#make-test):

MakeMaker checks for the existence of a file named test.pl in the

The problem is that "F" should be "test.pl".

Viewing the HTML source code for both version shows that the HTML
files are translated incorrectly for 5.10.1.

HTML source for 5.10.1 (incorrect):

MakeMaker checks for the existence of a file named F in the

HTML source for 5.10.0 (correct):

MakeMaker checks for the existence of a file named test.pl in the

When I run pod2html myself on the MakeMaker.pm file, the output HTML
file looks correct.

How are the HTML files created for the perldoc.perl.org website?
If I had some insight into this, I could try to find the root of the problem.

This problem exists for these Perl versions on perldoc.perl.org:
5.12.1 -- current
5.12.0
5.10.1

This problem does not exist for these Perl versions on perldoc.perl.org:
5.10.0
5.8.9
5.8.8

The problem is limited to some core modules; other core modules
render the POD Formatting Codes correctly, such as Carp.

@jonallen
Copy link
Owner

jonallen commented Sep 3, 2010

This appears to be a problem with the latest version of Pod::POM from CPAN, which is the underlying module used to create the perldoc HTML.

@gsullivan
Copy link
Author

The problem appears to be solved. The web pages look good now. Did you roll back the version of Pod::POM?

@timgimyee
Copy link

This issue seems to have resurfaced. From 5.26.1, this is the 2nd paragraph under "OBJECT-ORIENTED INTERFACE" in File::Temp:

Note that there is no method to obtain the filehandle from the C object.
The object itself acts as a filehandle. The object isa C and isa C
so all those methods are available.

Have to go back to 5.18.2 to get a good rendering:

Note that there is no method to obtain the filehandle from the File::Temp object.
The object itself acts as a filehandle. The object isa IO::Handle and isa IO::Seekable 
so all those methods are available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants