[Bioperl-l] escaping prime characters in POD?

[Jason Stajich]

I noticed that too - i guess the HTML POD translators do a better job
than the plain text ones.
I also notice that the L<...> are not translated very nicely either.

Can we outline the documentation standard (formatting, how to escape < &
>, etc) in a wiki - probably at the end of the coding standards page.


-jason
On Fri, 14 Dec 2001, Heikki Lehvaslaiho wrote:

>
> I've been cleaning the POD codumentation lately and last night I ran into
> something I do not understand: If there is ' character like in a word
> "don't", most people escape it into "don\'t" to keep perl syntax
> highlighting happy. Since these backlashes do not appear on bioperl html doc
> pages, I have assumed that perl POD translators remove them. But yesterday I
> noticed that in fact they do not. So what is going on? Is someone removing
> them from HTML files separately or what is happening to them?
>
> I've actually removed most of \' from HEAD but I have not committed
> anything.
>
> 	-Heikki
>
>
>

-- 
Jason Stajich
Duke University
jason@cgt.mc.duke.edu