Re: Fix typo in code comment

From: Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>
To: Ashutosh Bapat <ashutosh(dot)bapat(dot)oss(at)gmail(dot)com>
Cc: Dewei Dai <daidewei1970(at)163(dot)com>, Pgsql Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Fix typo in code comment
Date: 2026-01-09 04:28:33
Message-ID: CAA4eK1+iUEOZUROHnc1m8A3zTu4uSgtVb0sZrh_WRSWjQBOY9Q@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, Jan 8, 2026 at 8:54 PM Ashutosh Bapat
<ashutosh(dot)bapat(dot)oss(at)gmail(dot)com> wrote:
>
> On Wed, Jan 7, 2026 at 4:50 PM Dewei Dai <daidewei1970(at)163(dot)com> wrote:
> >
> > Hi hickers,
> > I fixed a comment error in origin.c.
> > The original comment was "* Replication origin consist out of a descriptive, user defined, externa..."
> > where I think "consist out of" is a typo and it should be "consists of".
> >
>
> You are right. LGTM.
>

I pushed that change but we can still improve it if we decide on a
better version of the comment.

> However, I find use of "consist of" itself not so accurate. consists
> of is used to denote relationship between whole and its parts. But
> what the sentence talks about is alternate representations of
> replication origin - long and short one. I think the sentence should
> be rewritten as "Replication origin has two interchangeable
> identifications: a descriptive .... ". What do you think?
>

I am not so sure of the interchangeable part because here we seem to
be talking about Replication origin identity, it seems the missing
information is that internal representation is a 2-byte *identifier*.
So, we could improve it in one of the following ways:

1.
* Replication origins consist of two parts:
* - A descriptive, user-defined external name
* - A short, space-efficient internal identifier (2 bytes)

2. Replication origin consists of a descriptive, user defined,
external name and a short, thus space efficient, internal 2 byte
identifier one.

--
With Regards,
Amit Kapila.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Junwang Zhao 2026-01-09 04:52:30 Re: SQL Property Graph Queries (SQL/PGQ)
Previous Message Japin Li 2026-01-09 04:10:58 Unstable isolation timeouts regression test on NetBSD?