Skip Menu |
 

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Pod-Weaver CPAN distribution.

Report information
The Basics
Id: 50888
Status: new
Priority: 0/
Queue: Pod-Weaver

People
Owner: Nobody in particular
Requestors: MARKSTOS [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Wishlist
Broken in: 3.093000
Fixed in: (no value)



Subject: wish: example in or near synopsis.
Download (untitled) / with headers
text/plain 636b
I can see value here in decoupling where POD is stored in files and how it is presented. Just after (or during) the SYNOPSIS, I think it makes sense to show a brief example of what the input, output and processing code looks like. Something like what's in "t/eg" seems like it would be appropriate. The tool reminds me of how the darcs manual is organized. Some of the code for it is strewn throughout various files where it is intermixed with the code. The "make" system then has logic to collect and present all the documentation in the form of a manual. I could see a larger-sized Perl project using Pod::Weaver for that.


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.