Re: my pod isn't showing up on search.cpan.org but shows on metacpan (module name, manifest, preview)

[Anonymous Monk]

in reply to my pod isn't showing up on search.cpan.org but shows on metacpan

Generally, the NAME section is expected to match the package name, which is supposed to match the the file name to qualify as a module name

But you can view your file via manifest (or keyboard) ;)

http://search.cpan.org/~gideon/Net-StackExchange2-0.01_2/MANIFEST -> http://search.cpan.org/~gideon/Net-StackExchange2-0.01_2/lib/Net/StackExchange2/V2.pm

Though I've not used it, http://search.cpan.org/pod2html PREVIEW might help in the future,

Example of this naming convention

$ module-starter --module Shabba --email email --author author --verbo
+se
Created Shabba
Created Shabba\lib
Created Shabba\lib\Shabba.pm
Created Shabba\t
Created Shabba\t\pod-coverage.t
Created Shabba\t\pod.t
Created Shabba\t\manifest.t
Created Shabba\t\boilerplate.t
Created Shabba\t\00-load.t
Created Shabba\ignore.txt
Created Shabba\Makefile.PL
Created Shabba\Changes
Created Shabba\README
Added to MANIFEST: Changes
Added to MANIFEST: ignore.txt
Added to MANIFEST: lib/Shabba.pm
Added to MANIFEST: Makefile.PL
Added to MANIFEST: MANIFEST
Added to MANIFEST: README
Added to MANIFEST: t/00-load.t
Added to MANIFEST: t/boilerplate.t
Added to MANIFEST: t/manifest.t
Added to MANIFEST: t/pod-coverage.t
Added to MANIFEST: t/pod.t
Created Shabba\MANIFEST
Created starter directories and files

$ perldoc Shabba\lib\Shabba.pm |head -n2
NAME
    Shabba - The great new Shabba!

$ perldoc -u Shabba\lib\Shabba.pm |head -n3
=head1 NAME

Shabba - The great new Shabba!

[gideondsouza]

Thanks very much for your reply. I had a slight inkling that was it but didn't really think it through.It's a little cryptic but, oh well, off I goto change my module.

Is this fact documented somewhere? I check my pod on the command line with perldoc.

[Anonymous Monk]

s/cryptic/convention/

It has been a convention for more than a decade -- probably documented somewhere (i don't know where), maybe https://pause.perl.org/pause/query?ACTION=pause_namingmodules, maybe http://www.cpan.org/modules/04pause.html, maybe perlnewmod, maybe (UTSL) http://github.com/andk/pause, maybe perlpodstyle, perlmodstyle, perlutil, perlglossary, I really can't be bothered to track it down

[Anonymous Monk]

This convention could be inherited from manpages

Conventional section names include NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, CONFORMING TO, NOTES, BUGS, EXAMPLE, AUTHORS, and SEE ALSO.