develooper Front page | perl.pod-people | Postings from April 2012

Re: Strange perldoc perldoc

Thread Previous
From:
Russ Allbery
Date:
April 30, 2012 08:39
Subject:
Re: Strange perldoc perldoc
Message ID:
87ipghb55h.fsf@windlord.stanford.edu
Shawn H Corey <shawnhcorey@gmail.com> writes:
> On 12-04-30 11:19 AM, Russ Allbery wrote:

>> I suspect indentation wasn't the goal, but rather preserving
>> formatting.  There currently isn't any way in POD to preserve line
>> breaks and allow inline formatting, which gets a little annoying when
>> writing man pages.

> Well, POD is suppose to be simple. If Mr. Wall wanted the full power of
> groff/nroff/troff, he would have written his documentation in them. The
> idea is to fit the documentation to the format, not the other way around.

> Yeah, it can be annoying but the most important thing about the
> documentation is its content, not its appearance. So don't plan to get to
> fancy with formatting.

Right, I generally agree.  I've just seen other people do this before, so
I can make a good guess at the thought process that was behind it.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>

Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About