Re: Adding comments to extension objects

From: Hannu Krosing <hannuk(at)google(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Andrew Dunstan <andrew(at)dunslane(dot)net>, PostgreSQL-development <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Adding comments to extension objects
Date: 2026-08-09 11:22:19
Message-ID: CAMT0RQQ3Trij=v9jtfHNdt9EJSqB6pD2weg6WnFRMUVf9pobrA@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Sometimes I wish there were something like Python's docstrings where
you can get more detailed usage instructions interactively.

So something like comments, but more detailed.

It could be exposed as CALL HELP(<the object name>) returning whatever
is there in the system.

On Sun, Aug 9, 2026 at 1:48 AM Bruce Momjian <bruce(at)momjian(dot)us> wrote:
>
> On Sat, Aug 8, 2026 at 06:12:40PM -0400, Andrew Dunstan wrote:
> > So, if your extension creates a Foreign Data Wrapper, as several of mine do,
> > there's really nothing for you to do. By all means comment on it, but it is
> > very unlikely to help an MCP server. On the other hand, if it creates functions
> > and types, commenting on those is probably a good idea, and if it creates
> > tables it's a very good idea.
> >
> > I also asked claude for a template. It gave me one with a worked example. It's
> > attached.
>
> Great idea to use Claude. Also, we should consider cases where it will
> help users but not necessarily MCP. FYI, pgvector already completed my
> request:
>
> https://github.com/pgvector/pgvector/issues/1013
>
> --
> Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
> EDB https://enterprisedb.com
>
> Do not let urgent matters crowd out time for investment in the future.
>
>

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tatsuya Kawata 2026-08-09 11:22:35 [PATCH] Remove stale comment and dead store in BuildTupleHashTable
Previous Message Alexander Lakhin 2026-08-09 10:00:00 Re: 019_replslot_limit.pl might fail due to checkpoint skipped