Re: Move Section 9.27.7 (Data Object Management Functions) to System Information Chapter

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Move Section 9.27.7 (Data Object Management Functions) to System Information Chapter
Date: 2022-07-14 22:57:29
Message-ID: 3170227.1657839449@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Bruce Momjian <bruce(at)momjian(dot)us> writes:
> On Mon, Apr 25, 2022 at 08:33:47AM -0700, David G. Johnston wrote:
>> Both the location and name of the linked to section make no sense to me:
>> https://www.postgresql.org/docs/current/functions-admin.html#
>> FUNCTIONS-ADMIN-DBOBJECT
>> Neither of the tables listed there manage (cause to change) anything.  They are
>> pure informational functions - size and path of objects respectively.  It
>> belongs in the previous chapter "System Information Functions and Operators"
>> with a different name.

> So, the section title is:
> 9.27.7. Database Object Management Functions
> I think the idea is that they _help_ to manage database objects by
> reporting their size or location. I do think it is in the right
> chapter, but maybe needs a better title? I can't think of one.

I'm hesitant to move functions to a different documentation page
without a really solid reason. Just a couple days ago I fielded a
complaint from somebody who couldn't find string_to_array anymore
because we'd moved it from "array functions" to "string functions".

I'd be the first to say that the division between 9.26 and 9.27 is
pretty arbitrary ... but without a clearer demarcation rule,
moving functions between the two pages seems more likely to
add confusion than subtract it.

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2022-07-14 22:57:35 Re: pg_parameter_aclcheck() and trusted extensions
Previous Message Peter Geoghegan 2022-07-14 22:51:07 Re: [PATCH v1] remove redundant check of item pointer