Skip Menu |
 

This queue is for tickets about the MIME-tools CPAN distribution.

Report information
The Basics
Id: 30391
Status: resolved
Priority: 0/
Queue: MIME-tools

People
Owner: dmo+pause [...] dmo.ca
Requestors: dgatwood [...] mac.com
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: (no value)
Fixed in: 5.427



Subject: Please add SEE ALSO section to manual pages
Download (untitled) / with headers
text/plain 997b
The manual pages---in particular, sparse leaf pages like MIME::Decoder::Gzip64(3pm)--- should contain a SEE ALSO section to point to related manual pages higher up in the class hierarchy. Right now, the only cross-reference (of sorts) is in the SYNOPSIS section. This poses two problems. First, the SYNOPSIS section is generally not used for that, so people aren't used to looking for it there. Second, it is at the top of the document, which means that when you reach the bottom of the document and still haven't found what you were looking for, you have to then know to read the document a second time from the top to find the reference to more information. As a result, most people miss it entirely and just send nasty feedback to people who maintain web versions of these pages. :-) Please add SEE ALSO sections for these minor leaf pages to point people back to the main class pages. This will make navigation much better, particularly on web site versions of the content.
Docs will have SEE ALSO sections in next release.
Fixed in 5.427


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.