MIME-Version: 1.0
References: <DHCYFNC0WIF4.3T1M8AUK0DG7T@gmail.com>
 <CA+Tgmob-0W8306mvrJX5Urtqt1AAasu8pi4yLrZ1XfwZU-Uj1w@mail.gmail.com>
 <CA+TgmoYUdeCdGfk8H6Ni2obXVixLvYaDkRGtxKLEmaCVNffsVA@mail.gmail.com>
 <DHHB7U2PSFYG.1A0WVPTX5LNOD@gmail.com>
 <CA+TgmoacOujCREMtQwURTSokB+ks-eLgaQ5vBMdWG959XzFcrA@mail.gmail.com>
 <CAP53PkwsnhmoLXJaUMKWc76S21GzYOX06qKyZdVZhGGW0rCWKw@mail.gmail.com>
In-Reply-To: 
 <CAP53PkwsnhmoLXJaUMKWc76S21GzYOX06qKyZdVZhGGW0rCWKw@mail.gmail.com>
From: Robert Haas <robertmhaas@gmail.com>
Date: Mon, 6 Apr 2026 11:22:42 -0400
Message-ID: 
 <CA+TgmobjYqq-s10BHtDDwBZtKFrN1WjK75Sai95=Lq77hWpXsQ@mail.gmail.com>
Subject: Re: Add custom EXPLAIN options support to auto_explain
To: Lukas Fittl <lukas@fittl.com>
Cc: Matheus Alcantara <matheusssilv97@gmail.com>,
 pgsql-hackers@lists.postgresql.org,
	Tom Lane <tgl@sss.pgh.pa.us>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: 
 <https://www.postgresql.org/message-id/CA%2BTgmobjYqq-s10BHtDDwBZtKFrN1WjK75Sai95%3DLq77hWpXsQ%40mail.gmail.com>
Precedence: bulk

On Fri, Apr 3, 2026 at 10:09=E2=80=AFPM Lukas Fittl <lukas@fittl.com> wrote=
:
> Maybe make it clear in the comment that the return value is
> unterminated (e.g. "The return value is the unterminated identifier"),
> i.e. caller is responsible for setting the null byte based on endp.
>
> Otherwise 0001 looks good.

Thanks for the review, but I don't agree with that proposed change. To
me, it seems too much like insisting that a function must document the
things it doesn't do. Granted, saying "this function doesn't overwrite
*endp" is a much more reasonable thing to document than "this function
doesn't try to compute pi to 3,141,593 decimal places," because the
latter is less likely to be something that the user would expect it to
do. But I feel like the comment is clear enough as it is, so I've
committed the patch without change. If more votes in favor of
adjusting the comment emerge, we can certainly reconsider.

--=20
Robert Haas
EDB: http://www.enterprisedb.com