Re: [PATCH] Add section headings to index types doc

From: Jürgen Purtz <juergen(at)purtz(dot)de>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Dagfinn Ilmari Mannsåker <ilmari(at)ilmari(dot)org>, Michael Paquier <michael(at)paquier(dot)xyz>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: [PATCH] Add section headings to index types doc
Date: 2020-10-25 09:40:07
Message-ID: dade356d-057a-d488-709b-bdb17713dd3c@purtz.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 23.10.20 18:08, David G. Johnston wrote:
> On Fri, Oct 23, 2020 at 3:18 AM Jürgen Purtz <juergen(at)purtz(dot)de
> <mailto:juergen(at)purtz(dot)de>> wrote:
>
>> and add a link to the "CREATE INDEX" command from the chapter
>> preamble.
> is the link necessary?
>
>
> I suppose it would make more sense to add it to the previous section -
> the introduction page.  I do think having a link (or more than one) to
> CREATE INDEX from the Indexes chapter is reader friendly.  Having
> links to SQL commands is never truly necessary - the reader knows a
> SQL command reference exists and the name of the command allows them
> to find the correct page.
>
> David J.
>
I'm afraid I haven't grasped everything of your intentions and
suggestions of your last two mails.

- equal operator in standalone paragraph: ok, integrated.

- shift "create index ... using HASH" to a different place: You suggest
shifting the statement or a link to the previous (sub-)chapter "11.1
Introduction"? But there is already a "create index" example. Please
read my suggestion/modification in the first paragraph of the "11.2
Index Types" page.

- "rewording hash": I don't know what is missing here. But I have added
a few words about the nature of this index type.

Attached are two patches: a) summary against master and b) standalone of
my current changes.

--

J. Purtz

Attachment Content-Type Size
0003-index-types-vs-master.patch text/x-patch 42.6 KB
0003-index-types.patch text/x-patch 1.5 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message David Rowley 2020-10-25 09:42:08 Re: Fix typo in src/backend/utils/cache/lsyscache.c
Previous Message Noah Misch 2020-10-25 05:18:36 Re: pgstat_report_activity() and parallel CREATE INDEX (was: Parallel index creation & pg_stat_activity)