Re: code example wrapping

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Erik Rijkers <er(at)xs4all(dot)nl>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, pgsql-docs(at)postgresql(dot)org
Subject: Re: code example wrapping
Date: 2010-04-05 17:29:31
Message-ID: 1270488571.18421.6.camel@vanquo.pezone.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On mån, 2010-04-05 at 18:30 +0200, Erik Rijkers wrote:
> On Mon, April 5, 2010 18:18, Tom Lane wrote:
> > "Erik Rijkers" <er(at)xs4all(dot)nl> writes:
> >> The manual has quite a few cases in the code-examples where, in the pdf version, there isn't
> >> enough width to show the whole line. Unfortunately, the rest of the line is then simply cut
> >> off,
> >> making the example 'invalid' (while reading, but also for copy-paste).
> >
> >> I would like to reformat (only) those cases so that the text is completely readable on the pdf
> >> page.
>
> > Exactly what width do you intend to wrap to, and how did you arrive at
> > the number?
> >
>
> I want to manually reformat, rather than automatically wrap to some fixed width.
>
> The width would be determined by readability of the .pdf versions (-A4, -US). Maybe I should
> check other formats at the same time?
>
> It looks like less than 60 or 80 would already solve most of the problem-cases. Obviously, the
> actual split should be determined by the syntax of the example.

Sure, makes sense. Lines much longer than 60-80 characters are probably
not too readable in any format.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Greg Smith 2010-04-05 19:30:46 Re: Documentation and explanatory diagrams
Previous Message Peter Eisentraut 2010-04-05 17:27:38 Re: Documentation and explanatory diagrams