Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Using .pod as a standalone file rather than in .pm and it showing up in MetaCPAN

by rockyb (Scribe)
on May 26, 2016 at 23:00 UTC ( [id://1164242]=perlquestion: print w/replies, xml ) Need Help??

rockyb has asked for the wisdom of the Perl Monks concerning the following question:

I'd prefer to have some documentation associated with a Perl Module, but I would rather not put it inside the code or .pm file but rather its own .pod file.

The reason I'd like to do this is so that it can be shared in say a github wiki where folks can interactively edit.

Before a release though, I'd copy the wiki into the distribution.

So what are practices or best practices for having documentation showing up on search.cpan.org or metacapan.org outside of the code?

  • Comment on Using .pod as a standalone file rather than in .pm and it showing up in MetaCPAN

Replies are listed 'Best First'.
Re: Using .pod as a standalone file rather than in .pm and it showing up in MetaCPAN
by LanX (Saint) on May 26, 2016 at 23:08 UTC
      Thanks. This is what I was looking for.
Re: Using .pod as a standalone file rather than in .pm and it showing up in MetaCPAN
by RonW (Parson) on May 27, 2016 at 00:45 UTC

    As LanX said, perldoc and metacpan will show the .pod instead of the .pm if there is one.

    Just checked, and it looks like cpan will, too, now.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: perlquestion [id://1164242]
Front-paged by stevieb
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others avoiding work at the Monastery: (4)
As of 2024-04-25 09:47 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found