How to get search.cpan to show script documentation?

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Joshua ben Jore - 28 Jun 2009 01:15 GMT

In App-Perldoc-Search, I have a script and two helper classes.
Search.cpan.org shows only the class's documentation and ignores that
I have a script. The script is the most important entry point. How do
I hint that it should render the POD in the script?

Build.PL
Changes
MANIFEST
MANIFEST.SKIP
README
lib/App/Perldoc/Search.pm
lib/App/Perldoc/Search/_Parser.pm

>>>>scripts/perldoc-search

t/App-Perldoc-Search.t

I let h2xs make my base dist for me, then edited to taste.

Josh

Reply to this Message

Shlomi Fish - 28 Jun 2009 07:08 GMT

> In App-Perldoc-Search, I have a script and two helper classes.
> Search.cpan.org shows only the class's documentation and ignores that
[quoted text clipped - 12 lines]
>
> t/App-Perldoc-Search.t

search.cpan.org seems to find the script fine in:

http://search.cpan.org/dist/App-XML-DocBook-Builder/

Thus, you may wish to follow my lead. I've placed my script under "script/"
instead of "scripts/".

> I let h2xs make my base dist for me, then edited to taste.

I should note that nowadays Module-Starter is considered more modern and
generally preferable over h2xs. Other modern alternatives include:

* http://search.cpan.org/dist/ExtUtils-ModuleMaker/

* http://search.cpan.org/dist/Dist-Zilla/ - this takes a different approach to
managing the code, by generating repetitive code from templates.

Regards,

Shlomi Fish

Signature

-----------------------------------------------------------------
Shlomi Fish http://www.shlomifish.org/
Stop Using MSIE - http://www.shlomifish.org/no-ie/

God gave us two eyes and ten fingers so we will type five times as much as we
read.

Reply to this Message

Webmaster Forum / Perl / Modules / June 2009

How to get search.cpan to show script documentation?