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

Potential bug ? Docuemntation links to the wrong thing #3262

Open
MartinMcGrath opened this issue Jan 8, 2025 · 2 comments
Open

Potential bug ? Docuemntation links to the wrong thing #3262

MartinMcGrath opened this issue Jan 8, 2025 · 2 comments
Labels

Comments

@MartinMcGrath
Copy link
Contributor

Good morning, I searched all issues and was unable to find a match.

Visit https://metacpan.org/pod/perlpod#SEE-ALSO

click 'perldoc', note that this links to POD2-ES -> perldoc rather than perldoc.

Initially there was a thought that the POD2-ES links were showing as they had more ++s, however this theory doesn't seem valid as the 'intended' perldoc now has more than the POD2-ES one. Perhaps related to the alphanumeric ordering of the results for a metacpan search.

Please note I didn't spot this, I saw this converstaion this morning.

@MartinMcGrath MartinMcGrath changed the title Potential bug ? Docuemntation links to the wrong module Potential bug ? Docuemntation links to the wrong thing Jan 8, 2025
@haarg
Copy link
Member

haarg commented Jan 8, 2025

perldoc is not an indexed module, so in a sense there is no "correct" place to link to. Instead, a guess is done based on various factors.

https://github.com/metacpan/metacpan-api/blob/master/lib/MetaCPAN/Document/File/Set.pm#L68-L134

Checking the various sorted fields will be needed to see why this particular pod file is being used.

@Grinnz
Copy link
Contributor

Grinnz commented Jan 8, 2025

Several core perldocs are not readable on metacpan because it displays the contents of the tarball not the installed documentation, which is why https://perldoc.perl.org exists.

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

No branches or pull requests

3 participants