develooper Front page | perl.perl5.porters | Postings from March 2009

Re: [PATCH] Markup in the NAME section is not portable

Thread Previous | Thread Next
Michael G Schwern
March 5, 2009 16:13
Re: [PATCH] Markup in the NAME section is not portable
Message ID:
Russ Allbery wrote:
> Michael G Schwern <> writes:
>> To answer your question at the top, I write Perl documentation.  I use
>> perldoc instead of man.  Guarantees I get the right version of the page
>> and I know its always going to work.
>> I agree there's no doubt that Perl module style is heavily derived from
>> man page standards.  It would be very nice to write those down.  pod2man
>> is the only place I believe anyone has tried.
> I can try to tackle a perlpodstyle documentation page, which I can either
> ship with podlators or hand off to the Perl core team as makes the most
> sense.  I'm somewhat handicapped by not having time to read perl5-porters,
> although I do read pod-people.

Maybe so we can rapidly get chunks of information in there some sort of wiki?
 Some sort of podwiki?

Which reminds me, I need to finish hacking podwiki to allow pluggable version
control systems.

> Okay, I can live with that (and modify Pod::Man to strip B<> and I<>
> markup in NAME as well).  As long as we don't go farther down that path
> and allow verbatim paragraphs, subheadings, or move away from the Name -
> Description syntax, you're certainly correct that formatters can cope.

Agreed.  All that is necessary to scrape the semantics out of NAME.

There will be snacks.

Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About