On Dec 1, 2009, at 12:18 PM, Ricardo Signes wrote:

>> Yeah, and it looks like it pretty well matches what RJBS and I sketched out.
>> Ricardo, are you looking to update perlpod and perlpodspec for 5.12, then? As
>> soon as that's in, I'll send a patch for Test::Pod (turns out the change is
>> quite simple).
> 
> I will update the documents, although I'm not sure if Jesse will want to get 
> those changes in 5.12.  I'll talk to him.  If he's game, I'll do it.

Cool.

I just wrote tests for the text output from Pod::Simple::Text. It's like this:

            POD                     | Text Output
    --------------------------------+------------------
    L<things|crontab(5)>            | things
    L<things|crontab(5)/foo>        | things
    L<Perl Error Messages|perldiag> | Perl Error Message
    L<perl.org|http://perl.org>     | perl.org

I think it most unfortunate that the URL is lost in text output. I see two ways 
around this:

1. Change it to output with the URL using something like Markdown format:

            POD                     | Text Output
    --------------------------------+--------------------------------
    L<things|crontab(5)>            | [things](crontab(5))
    L<things|crontab(5)/foo>        | [things](crontab(5)/foo)
    L<Perl Error Messages|perldiag> | [Perl Error Message](perldiag)
    L<perl.org|http://perl.org>     | [perl.org](http://perl.org)

2. Or, if people hate that, perhaps implement Pod::Simple::Markdown to emit 
Markdown and leave Pod::Simple::Text as-is.

Thoughts?

Not sure what Pod::Man does…

Best,

David

Reply via email to