Re: pgsql: Doc: Explain about Column List feature.
Alvaro Herrera <alvherre@alvh.no-ip.org>
From: Alvaro Herrera <alvherre@alvh.no-ip.org>
To: Peter Smith <smithpb2250@gmail.com>
Cc: Amit Kapila <akapila@postgresql.org>, pgsql-hackers@lists.postgresql.org
Date: 2022-12-19T16:47:13Z
Lists: pgsql-hackers
Attachments
- 0001-Rework-warning-about-column-list-combining.patch (text/x-diff)
On 2022-Sep-15, Alvaro Herrera wrote: > On 2022-Sep-15, Alvaro Herrera wrote: > > > Looking at the rendered docs again, I notice that section "31.4.5. > > Combining Multiple Column Lists" is *only* the red-tinted Warning block. > > That seems quite odd. I am tempted to remove the sect2 heading for that > > one too. > > Pushed. I didn't modify this part; I spent too much time looking at it > trying to figure out how to do it. I think this bit really belongs in > the CREATE/ALTER docs rather than this chapter. But in order to support > having a separate <para> for the restriction on combination, we need a > separate <varlistentry> for the column_name parameter. So I'm going to > edit that one and I'll throw this change in. I figured out how to fix this one -- just remove the <sect2> tags, and add a <title> tag to the <warning> box. The attached yields the explanatory text in a separate box that doesn't have the silly otherwise-empty section title. We add the 'id' that was in the sect2 to the warning; with this, at the referencing end the full title is rendered, which looks quite reasonable. I have attached screenshots of both sides of this. Compare the existing https://www.postgresql.org/docs/15/logical-replication-col-lists.html#LOGICAL-REPLICATION-COL-LIST-COMBINING Unless there are objections, I'll get this pushed to 15 and master. -- Álvaro Herrera Breisgau, Deutschland — https://www.EnterpriseDB.com/
Commits
-
Rework <warning> box about column list combining in logical replication
- d8209d09170f 15.2 landed
- c6f21b2ac215 16.0 landed
-
Copy-edit docs for logical replication column lists
- bfa58a679a57 15.0 landed
- 3a06a79cd137 16.0 landed
-
Doc: Explain about Column List feature.
- f98d07424523 16.0 cited