Re: Documentation improvements for partitioning

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: Amit Langote <Langote_Amit_f8(at)lab(dot)ntt(dot)co(dot)jp>, Simon Riggs <simon(at)2ndquadrant(dot)com>, Corey Huinker <corey(dot)huinker(at)gmail(dot)com>, Pg Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Documentation improvements for partitioning
Date: 2017-03-09 19:37:53
Message-ID: 7256.1489088273@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Robert Haas <robertmhaas(at)gmail(dot)com> writes:
> This is about list-ifying a note, but I think we should try to
> de-note-ify it. It's a giant block of text that is not obviously more
> noteworthy than the surrounding text; I think <note> should be saved
> for things that particularly need to be called out.

Yeah. A big problem with the markup we use, imo, is that <note> segments
are displayed in a way that makes them more prominent than the surrounding
text, not less so. That doesn't really square with my intuitive view of
what a <note> ought to be used for; it forces it to be considered as
something only slightly less dangerous than a <caution> or <warning>, not
as a parenthetical remark. But that's what we have to deal with so
we should mark up our text accordingly.

regards, tom lane

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2017-03-09 19:41:41 Re: Query fails when SRFs are part of FROM clause (Commit id: 69f4b9c85f)
Previous Message Peter Eisentraut 2017-03-09 19:30:21 Re: exposing wait events for non-backends (was: Tracking wait event for latches)