public inbox for [email protected]  
help / color / mirror / Atom feed
From: Robert Haas <[email protected]>
To: Lukas Fittl <[email protected]>
Cc: Matheus Alcantara <[email protected]>
Cc: [email protected]
Cc: Tom Lane <[email protected]>
Subject: Re: Add custom EXPLAIN options support to auto_explain
Date: Mon, 6 Apr 2026 11:22:42 -0400
Message-ID: <CA+TgmobjYqq-s10BHtDDwBZtKFrN1WjK75Sai95=Lq77hWpXsQ@mail.gmail.com> (raw)
In-Reply-To: <CAP53PkwsnhmoLXJaUMKWc76S21GzYOX06qKyZdVZhGGW0rCWKw@mail.gmail.com>
References: <[email protected]>
	<CA+Tgmob-0W8306mvrJX5Urtqt1AAasu8pi4yLrZ1XfwZU-Uj1w@mail.gmail.com>
	<CA+TgmoYUdeCdGfk8H6Ni2obXVixLvYaDkRGtxKLEmaCVNffsVA@mail.gmail.com>
	<[email protected]>
	<CA+TgmoacOujCREMtQwURTSokB+ks-eLgaQ5vBMdWG959XzFcrA@mail.gmail.com>
	<CAP53PkwsnhmoLXJaUMKWc76S21GzYOX06qKyZdVZhGGW0rCWKw@mail.gmail.com>

On Fri, Apr 3, 2026 at 10:09 PM Lukas Fittl <[email protected]> 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.

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





view thread (16+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Add custom EXPLAIN options support to auto_explain
  In-Reply-To: <CA+TgmobjYqq-s10BHtDDwBZtKFrN1WjK75Sai95=Lq77hWpXsQ@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox