Re: Another modest proposal for docs formatting: catalog descriptions

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>
Cc: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Another modest proposal for docs formatting: catalog descriptions
Date: 2020-05-09 15:34:24
Message-ID: 4521.1589038464@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr> writes:
>> Here's a more fully fleshed out draft for this, with stylesheet
>> markup to get extra space around the column type names.

> I find this added spacing awkward, espacially as attribute names are
> always one word anyway. I prefer the non spaced approach.

It's certainly arguable that that look is too heavy-handed. In the
attached, I knocked down the extra space from 1em to 0.25em, which
makes it quite a bit subtler --- are you any happier with this?

BTW, I don't think it's very accurate that "attribute names are
always one word" --- see the second attachment. Here if anything
I'm wanting a little more space.

> If spacing is discussed, should the layout rather try to align type
> information, eg:

I thought about that, but it seems extremely close to some of the
earlier function-table layouts that were so widely panned. The SGML
source would have to be a lot uglier too, probably with explicit use
of spanspec's on every row. It could be done no doubt, but I think
people would not see it as an improvement.

regards, tom lane

Attachment Content-Type Size
pg-aggregate-quarter-em.png image/png 196.7 KB
info-schema-quarter-em.png image/png 141.5 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Fabien COELHO 2020-05-09 17:30:11 Re: Another modest proposal for docs formatting: catalog descriptions
Previous Message Tom Lane 2020-05-09 15:17:26 Re: Logical replication subscription owner

Browse pgsql-hackers by date

  From Date Subject
Next Message Fabien COELHO 2020-05-09 17:30:11 Re: Another modest proposal for docs formatting: catalog descriptions
Previous Message Tom Lane 2020-05-09 15:17:26 Re: Logical replication subscription owner