Re: DOCS - pg_replication_slot . Fix the 'inactive_since' description

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com>
Cc: "amit(dot)kapila16(at)gmail(dot)com" <amit(dot)kapila16(at)gmail(dot)com>, "shveta(dot)malik(at)gmail(dot)com" <shveta(dot)malik(at)gmail(dot)com>, "smithpb2250(at)gmail(dot)com" <smithpb2250(at)gmail(dot)com>, "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS - pg_replication_slot . Fix the 'inactive_since' description
Date: 2024-09-04 06:04:28
Message-ID: CAKFQuwY6hu4NUT8aBsoRO7VFA4rc-01Ji9b_od4_1Mf72F2UjQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Tuesday, September 3, 2024, Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com>
wrote:

> At Tue, 3 Sep 2024 10:43:14 +0530, Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>
> wrote in
> > On Mon, Sep 2, 2024 at 9:14 AM shveta malik <shveta(dot)malik(at)gmail(dot)com>
> wrote:
> > >
> > > On Mon, Sep 2, 2024 at 5:47 AM Peter Smith <smithpb2250(at)gmail(dot)com>
> wrote:
> > > > ----
> > > >
> > > > To summarize, the current description wrongly describes the field as
> a
> > > > time duration:
> > > > "The time since the slot has become inactive."
> > > >
> > > > I suggest replacing it with:
> > > > "The slot has been inactive since this time."
> > > >
> > >
> > > +1 for the change. If I had read the document without knowing about
> > > the patch, I too would have interpreted it as a duration.
> > >
> >
> > The suggested change looks good to me as well. I'll wait for a day or
> > two before pushing to see if anyone thinks otherwise.
>
> If possible, I'd prefer to use "the time" as the subject. For example,
> would "The time this slot was inactivated" be acceptable? However,
> this loses the sense of continuation up to that point, so if that's
> crucial, the current proposal might be better.
>

Agree on sticking with “The time…”

Thus I suggest either:

The time when the slot became inactive.
The time when the slot was deactivated.

Apparently inactivate is a valid choice here but it definitely sounds like
unusual usage in this context. Existing usage (via GibHub search…someone
may want to grep) seems to support deactivate as well.

I like the first suggestion more, especially since becoming inactive can
happen without user input. Saying deactivate could be seen to imply user
intervention.

David J.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2024-09-04 06:12:37 Re: Add callbacks for fixed-numbered stats flush in pgstats
Previous Message Michael Paquier 2024-09-04 06:04:09 Re: Add callback in pgstats for backend initialization