Re: DOCS: add helpful partitioning links

From: Ashutosh Bapat <ashutosh(dot)bapat(dot)oss(at)gmail(dot)com>
To: Robert Treat <rob(at)xzilla(dot)net>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS: add helpful partitioning links
Date: 2024-03-14 16:15:28
Message-ID: CAExHW5sOCjK3djTtJe2uT_0OoGKs9AxmkmCxXaD_8cCo7cqrqA@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi Robert,

On Thu, Mar 7, 2024 at 10:49 PM Robert Treat <rob(at)xzilla(dot)net> wrote:

> This patch adds a link to the "attach partition" command section
> (similar to the detach partition link above it) as well as a link to
> "create table like" as both commands contain additional information
> that users should review beyond what is laid out in this section.
> There's also a couple of wordsmiths in nearby areas to improve
> readability.
>

Thanks.

The patch gives error when building html

ddl.sgml:4300: element link: validity error : No declaration for attribute
linked of element link
<link linked="sql-createtable-parms-like"><literal>CREATE TABLE ...
LIKE</l
^
ddl.sgml:4300: element link: validity error : Element link does not carry
attribute linkend
nked="sql-createtable-parms-like"><literal>CREATE TABLE ...
LIKE</literal></link

^
make[1]: *** [Makefile:72: postgres-full.xml] Error 4
make[1]: *** Deleting file 'postgres-full.xml'
make[1]: Leaving directory
'/home/ashutosh/work/units/pg_review/coderoot/pg/doc/src/sgml'
make: *** [Makefile:8: html] Error 2

I have fixed in the attached.

- As an alternative, it is sometimes more convenient to create the
- new table outside the partition structure, and attach it as a
+ As an alternative, it is sometimes more convenient to create a
+ new table outside of the partition structure, and attach it as a

it uses article "the" for "new table" since it's referring to the partition
mentioned in the earlier example. I don't think using "a" is correct.

"outside" seems better than "outside of". See
https://english.stackexchange.com/questions/9700/outside-or-outside-of. But
I think the meaning of the sentence will be more clear if we rephrase it as
in the attached patch.

- convenient, as not only will the existing partitions become indexed,
but
- also any partitions that are created in the future will. One
limitation is
+ convenient as not only will the existing partitions become indexed,
but
+ any partitions created in the future will as well. One limitation is

I am finding the current construct hard to read. The comma is misplaced as
you have pointed out. The pair of commas break the "not only" ... "but
also" construct. I have tried to simplify the sentence in the attached.
Please review.

- the partitioned table; such an index is marked invalid, and the
partitions
- do not get the index applied automatically. The indexes on
partitions can
- be created individually using <literal>CONCURRENTLY</literal>, and
then
+ the partitioned table; such an index is marked invalid and the
partitions
+ do not get the index applied automatically. The partition indexes can

"indexes on partition" is clearer than "partition index". Fixed in the
attached patch.

Please review.

--
Best Wishes,
Ashutosh Bapat

Attachment Content-Type Size
improve-partition-links_v2.patch text/x-patch 3.6 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2024-03-14 16:37:14 Re: Possibility to disable `ALTER SYSTEM`
Previous Message Nathan Bossart 2024-03-14 16:10:42 Re: pg_column_toast_chunk_id: a function to get a chunk ID of a TOASTed value