Re: Documentation improvements for partitioning

From: Amit Langote <Langote_Amit_f8(at)lab(dot)ntt(dot)co(dot)jp>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: 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-10 01:23:16
Message-ID: a6f99cdb-21e7-1d65-1381-91f2cfa156e2@lab.ntt.co.jp
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 2017/03/10 3:26, Robert Haas wrote:
> I think you might have the titles for 0002 and 0003 backwards.

Oops, you're right.

> On Fri, Mar 3, 2017 at 2:51 AM, Amit Langote wrote:
>> 0002: some cosmetic fixes to create_table.sgml
>
> I think this sentence may be unclear to some readers:
>
> + One might however want to set it for only some partitions,
> + which is possible by doing <literal>SET NOT NULL</literal> on individual
> + partitions.
>
> I think you could replace this with something like: Even if there is
> no <literal>NOT NULL</> constraint on the parent, such a constraint
> can still be added to individual partitions, if desired; that is, the
> children can disallow nulls even if the parent allows them, but not
> the other way around.

Reads much better, done that way. Thanks.

>> 0003: add clarification about NOT NULL constraint on partition columns in
>> alter_table.sgml
>
> 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.

OK. The patch is now just about de-note-ifying the block of text. Since
I don't see any other lists in the Parameters portion of the page, I also
take back my list-ifying proposal.

Attached updated patches.

Thanks,
Amit

Attachment Content-Type Size
0001-Rewrite-sections-in-ddl.sgml-related-to-partitioning.patch text/x-diff 61.9 KB
0002-Add-a-note-about-DROP-NOT-NULL-and-partitions.patch text/x-diff 1.5 KB
0003-Listify-a-note-on-the-CREATE-TABLE-page.patch text/x-diff 4.7 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2017-03-10 01:26:22 Re: postgres_fdw IMPORT SCHEMA and partitioned tables
Previous Message Stephen Frost 2017-03-10 01:04:33 Re: GSOC Introduction / Eliminate O(N^2) scaling from rw-conflict tracking in serializable transactions