Re: doc - add missing documentation for "acldefault"

From: Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>
To: Joe Conway <mail(at)joeconway(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Pavel Luzanov <p(dot)luzanov(at)postgrespro(dot)ru>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: doc - add missing documentation for "acldefault"
Date: 2018-09-19 15:33:24
Message-ID: alpine.DEB.2.21.1809191723040.901@lancre
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


Hello,

>> Our normal policy is that we do not document functions that are meant to
>> be invoked through operators. The \df output saying that is sufficient:

The output of \df is one thing, but I was looking at pg online
documentation and hoping to find things as well.

\dfS returns nearly 3000 results, it is not really pratical unless you
already know what you are looking for, eg the name of the function...

>> I would strongly object to ignoring that policy in just one place.
>
> Ok, fair enough.
>
>> Actually, it appears that most of these functions have associated
>> operators:
>>
>> # select oid::regoperator, oprcode from pg_operator where oprright = 'aclitem'::regtype;
>> oid | oprcode
>> -----------------------+-------------
>> +(aclitem[],aclitem) | aclinsert
>> -(aclitem[],aclitem) | aclremove
>> @>(aclitem[],aclitem) | aclcontains
>> =(aclitem,aclitem) | aclitemeq
>> ~(aclitem[],aclitem) | aclcontains
>> (5 rows)
>>
>> So maybe what we really need is a table of operators not functions.

> Good idea -- I will take a look at that.

My initial complaint is that I did not know that there was an "acldefault"
function while I was looking for that kind of thing. ISTM that this one
should be kept explicitely in the doc.

I'm okay with documenting operators instead of the basic undelying
functions and skipping type management (in/out) functions, though.

--
Fabien.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tatsuo Ishii 2018-09-19 15:38:07 Re: Code of Conduct plan
Previous Message Fred Pratt 2018-09-19 15:27:23 Re: Code of Conduct