Re: Missing jsonb_ ... functions on DOCs

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>
Cc: Michael Paquier <michael(at)paquier(dot)xyz>, pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Missing jsonb_ ... functions on DOCs
Date: 2026-05-11 15:19:44
Message-ID: 2077214.1778512784@sss.pgh.pa.us
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> writes:
> Em dom., 10 de mai. de 2026 às 23:08, Michael Paquier <michael(at)paquier(dot)xyz>
> 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

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Dmitry Dolgov 2026-05-11 15:50:01 Re: Add ssl_(supported|shared)_groups to sslinfo
Previous Message Antonin Houska 2026-05-11 15:17:52 Re: Adding REPACK [concurrently]