Re: Operator class parameters and sgml docs

From: Alexander Korotkov <aekorotkov(at)gmail(dot)com>
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-20 10:55:33
Message-ID: CAPpHfdt6kWPUNhS4+RoA5=aUcWnip-1fU3VRT8dq=_UjMgP1+w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, Jun 18, 2020 at 8:06 PM Alexander Korotkov
<a(dot)korotkov(at)postgrespro(dot)ru> wrote:
> On Wed, Jun 17, 2020 at 2:00 PM Alexander Korotkov
> <a(dot)korotkov(at)postgrespro(dot)ru> wrote:
> > 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.
>
> I'm going to push this patch if there are no objections. I'm almost
> sure that documentation of opclass options will require further
> adjustments. However, I think the current patch makes it better, not
> worse.

So, pushed!

------
Regards,
Alexander Korotkov

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Kapila 2020-06-20 12:21:21 Re: Global snapshots
Previous Message Alexander Korotkov 2020-06-20 10:16:52 Re: Failures with wal_consistency_checking and 13~