Re: Attach comments to functions' parameters and return value

From: "Charles Clavadetscher" <clavadetscher(at)swisspug(dot)org>
To: "'Jim Nasby'" <Jim(dot)Nasby(at)BlueTreble(dot)com>, <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Attach comments to functions' parameters and return value
Date: 2015-09-15 10:13:55
Message-ID: 003701d0ef9f$40a75110$c1f5f330$@swisspug.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hello Jim

> -----Original Message-----
> From: pgsql-hackers-owner(at)postgresql(dot)org [mailto:pgsql-hackers-
> owner(at)postgresql(dot)org] On Behalf Of Charles Clavadetscher
> Sent: Dienstag, 15. September 2015 07:35
> To: Jim Nasby <Jim(dot)Nasby(at)BlueTreble(dot)com>; pgsql-hackers(at)postgresql(dot)org
> Subject: Re: [HACKERS] Attach comments to functions' parameters and return
> value
>
> Hello Jim
>
> On 14/09/2015 19:23, Jim Nasby wrote:
> > On 9/14/15 8:59 AM, Charles Clavadetscher wrote:
> >> Hello
> >>
> >> In PostgreSQL it is possible to attach comments to almost everything.
> >> This
> >> made it possible for us to integrate the wiki that we use for our
> >> technical
> >> documentation directly with the database using the MediaWiki [1]
> >> extensions
> >> ExternalData [2] and MagicNoCache [3]. The result is a documentation on
> >> tables and related objects (indexes, triggers, etc.) and views that
> >> always
> >> shows the current state, i.e. any DDL change or any comment attached
> >> to an
> >> object is shown in the wiki immediately (or on refresh if the change
was
> >> done after the reader landed on the page).
> >
> > Neat! I hope you'll open source that. :)
>
> Thank you for your answer. Sure I will put some information on it and
> the source on my website soon and let you know. There is not really much
> magic to it, but it can be quite helpful.

As promised:
http://www.schmiedewerkstatt.ch/wiki/index.php/Database_self-documenting_Wik
i

Feedback, as usual, is always welcome.

Bye
Charles

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Anastasia Lubennikova 2015-09-15 10:20:26 Re: [PROPOSAL] Covering + unique indexes.
Previous Message YUriy Zhuravlev 2015-09-15 10:01:10 Re: Move PinBuffer and UnpinBuffer to atomics