Tels wrote:
* has_pod_index: The POD contains at least one X<> keyword that helps
POD indexers. Whether only one is usefull is open for debate, because
at least the license (X<gpl>), your CPAN ID under authors (x<tels>),
and some generic keyword what your module (X<foo>) is about can
probably added even for the most minimal module.
Can you give an example of how this has any practical impact on
anything?
Here is the main page for the project.
http://pod-indexing.annocpan.org/wiki/index.cgi
They talk only about the Perl core doc at this point, probably because
adding keywords there is already enough work. AFAIK the core docs are now
covered, so individual modules would be next.
We are not done with the core docs yet; the list of documents that are
done is listed at
http://pod-indexing.annocpan.org/wiki/index.cgi?IndexStats . The next
stage in my plan would be to index the modules that come with the core
distribution. Indexing CPAN modules is up to each individual author and
I haven't really thought much about it yet.
Much as I love the POD indexing project, I'm reluctant to see this added
as a kwalitee point. First, because there are already enough complaints
that CPANTS is trying to "force" authors to do things in one specific
way needlessly; and second, because it would be too early anyway, as pod
indexing still needs to be tested in practice.
Getting off topic: I still have to figure out how a perldoc -k would
handle indexing of CPAN modules. The problem is that having too many
things indexed could be counterproductive. For example, doing "perldoc
-k pop" will give you the pop function (
http://pod-indexing.annocpan.org/perldoc-k.cgi?keyword=pop ), but what
would happen if you index all of CPAN and there are dozens of modules
that implement a "pop" method? I'm thinking that the best solution would
be to have the option of doing a "core search" vs a "global search"...
Cheers,
Ivan
