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.
  • Was this a Perl 6 specific thing? I find perldoc to be a wonderful tool myself but I don't know its state in P6.

    • Was this a Perl 6 specific thing? I find perldoc to be a wonderful tool myself but I don't know its state in P6.

      I realize I could have been more clear in this regard. Yes, this was a Perl 6-specific thing; I also like perldoc very much. Both on the command line and on the web [perl.org].

      The reason that the situation is different for Perl 6 is that Perl 6 is a complete rehaul of most everything. We can't just blindly inherit the docs, and we need to prepare new docs of the same high quality before our first major release. Documentation is one of those little things that matter a lot.

      In doing this, I think we should take not only perldoc as a model, but also things like ri, and we need to think about how to make maximum use of the web. As has been pointed out elsewhere, the PHP documentation on the web is a real boon for PHP itself, in that it (1) is comprehensive and easy to find, and (2) has very short and intuitive URLs. Wondering about chop? Go to http://php.net/chop [php.net]. It doesn't get much shorter and sweeter than that. (Juerd++ has a cool Perl 5 analogue [p3rl.org], but it's not official. What if we could design user documentation with cool URLs in mind from the start?)

      That said, I've yet to come across a language reference with a nicer layout than perldoc.perl.org [perl.org]. Some things, like most of perldoc, we do well already. Now we just need to steal all the best parts, from ourselves and from others.