Re: Operator class parameters and sgml docs

From: Alexander Korotkov <a(dot)korotkov(at)postgrespro(dot)ru>
To: Peter Geoghegan <pg(at)bowt(dot)ie>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Operator class parameters and sgml docs
Date: 2020-06-17 11:00:15
Message-ID: CAPpHfdv3bBjnOq6q2h_-eceHt6wiKasVgO2HSO14mkKPU+M42w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Jun 17, 2020 at 2:50 AM Peter Geoghegan <pg(at)bowt(dot)ie> wrote:
> On Tue, Jun 16, 2020 at 4:24 AM Alexander Korotkov
> <a(dot)korotkov(at)postgrespro(dot)ru> wrote:
> > Thank you for patience. The documentation patch is attached. I think
> > it requires review by native english speaker.
>
> * "...paramaters that controls" should be "...paramaters that control".
>
> * "with set of operator class specific option" should be "with a set
> of operator class specific options".
>
> * "The options could be accessible from each support function" should
> be "The options can be accessed from other support functions"

Fixed, thanks!

> It's very hard to write documentation like this, even for native
> English speakers. I think that it's important to have something in
> place, though. The GiST example helps a lot.

I've added a complete example for defining a set of parameters and
accessing them from another support function to the GiST
documentation.

------
Alexander Korotkov
Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company

Attachment Content-Type Size
opclass_options_doc_2.patch application/octet-stream 16.2 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2020-06-17 11:13:01 Re: Review for GetWALAvailability()
Previous Message Magnus Hagander 2020-06-17 10:32:14 Re: language cleanups in code and docs