public inbox for [email protected]  

help / color / mirror / Atom feed

From: Tom Lane <[email protected]>
To: Marcos Pegoraro <[email protected]>
Cc: Michael Paquier <[email protected]>
Cc: pgsql-hackers <[email protected]>
Subject: Re: Missing jsonb_ ... functions on DOCs
Date: Mon, 11 May 2026 11:19:44 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <CAB-JLwb+m=gspBheMGWq9TCPqgD70K30AQ3bNxPzg3KBsym2Bg@mail.gmail.com>
References: <CAB-JLwbPuNY+4Ez48TZpXg-ZuxRSJ_igsNOa-nX7jBEs97qHCQ@mail.gmail.com>
	<[email protected]>
	<CAB-JLwb+m=gspBheMGWq9TCPqgD70K30AQ3bNxPzg3KBsym2Bg@mail.gmail.com>

Marcos Pegoraro <[email protected]> writes:
> Em dom., 10 de mai. de 2026 às 23:08, Michael Paquier <[email protected]>
> escreveu:
>> Well, it seems to me that the intention is that it is pointless to
>> document the functions because that the users need only to be aware of
>> the operators, and the operators are enough to manipulate the jsonb
>> blobs.  Documenting the functions would be just duplicating what we
>> already have for the operators, as listed here:
>> https://www.postgresql.org/docs/devel/functions-json.html

> A function is self explanatory, an operator is not.

We have a general policy of not documenting functions that underlie
operators, simply because doing otherwise would bloat the
documentation enormously while not adding much value.  Do we really
need documentation entries for int4pl, int48gt, float84mul,
etc etc etc?

I'm sure there are a few places where that policy wasn't followed
for some reason, but I'm loath to abandon it.  There are circa
800 entries in pg_operator (and that's just for the core code).

			regards, tom lane

view thread (6+ 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]
  Subject: Re: Missing jsonb_ ... functions on DOCs
  In-Reply-To: <[email protected]>

* 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