Stories
Slash Boxes
Comments
NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

All the Perl that's Practical to Extract and Report

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.
  • Considering that one has to write documentation *first* in order to use POD. Too much complexity in what should be simple isn't really addressing the problem of not enough people document their modules. It's like people bitching about CPAN.pm yet they are usually the ones who either don't have a version or never bothered to read the documentation on what the appropriate version string is supposed to be. Close to 40% of the modules on CPAN either lack a version or POD or both. This isn't something XML is rea

    • I don't think Matt's idea was to add complexity. He wants to add power. Now, I know that the two often walk in pairs, the latter as the intention and the former as the result.

      I'm not in the camp of people that want to make Perl's documentation XML-based [mpe.mpg.de] (though I've come closer to it since that post, mostly for "enterprise" stuff and not for core Perl) but I could definitely use some extra metadata. The ActiveState people have been working on that (IIRC) and I'd love to hear about the output of their attempts.

      The basic idea, for me, is that it would be great to be able to document more precisely method signatures and class relationships, so that Perl editors could offer better autocomplete and so that docs could be usefully cross-linked in an automatic manner. Anyone who has looked up something in the LWP docs and subsequently had to go to HTTP::Response/Request, and then to HTTP::Message, and then $DEITY knows where will probably know what I mean :-)

      This doesn't mean adding more complexity. It simply means providing a standard way in POD to do that (standard as in "we all agree on it") so that people that want to use that kind of feature can. It really doesn't have to get in the way of those that don't want it.

      If, however, someone would give me a Wx POD editor, I'd be endlessly happy.

      --

      -- Robin Berjon [berjon.com]