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 18:09:01
Message-ID: 3357.1589047741@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:
> Possibly. I'm a little at odds with Type not being above types, but far on
> the left, so that you cannot really "see" that it is about the format,

Yeah, agreed. We can adjust the space in the header independently of
what's in the table entries, so it'd be possible to put more space
between "Column" and "Type" ... but I'm not sure if that would fix it.

> If I can suggest more adjustements, maybe the description margin is a too
> much, I'd propose reduce it to about 3 chars wide. Obviously any aesthetic
> opinion is by definition subjective and prone to differ from one person to
> the next…

This is more Jonathan's department than mine, but I personally prefer more
indentation to less --- you want the column names to stick out so you can
find them. Anyway, the present indentation is (it looks like) the same
as we are using in <variablelist>s, which this layout is based on.

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Stephen Frost 2020-05-09 18:09:33 Re: Logical replication subscription owner
Previous Message Fabien COELHO 2020-05-09 17:30:11 Re: Another modest proposal for docs formatting: catalog descriptions

Browse pgsql-hackers by date

  From Date Subject
Next Message Stephen Frost 2020-05-09 18:09:33 Re: Logical replication subscription owner
Previous Message Ranier Vilela 2020-05-09 17:51:50 Re: [PATCH] Fix division by zero (explain.c)