Re: Attach comments to functions' parameters and return value - Mailing list pgsql-hackers

From Charles Clavadetscher
Subject Re: Attach comments to functions' parameters and return value
Date
Msg-id 003701d0ef9f$40a75110$c1f5f330$@swisspug.org
Whole thread Raw
In response to Re: Attach comments to functions' parameters and return value  (Charles Clavadetscher <clavadetscher@swisspug.org>)
List pgsql-hackers
Hello Jim

> -----Original Message-----
> From: pgsql-hackers-owner@postgresql.org [mailto:pgsql-hackers-
> owner@postgresql.org] On Behalf Of Charles Clavadetscher
> Sent: Dienstag, 15. September 2015 07:35
> To: Jim Nasby <Jim.Nasby@BlueTreble.com>; pgsql-hackers@postgresql.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





pgsql-hackers by date:

Previous
From: YUriy Zhuravlev
Date:
Subject: Re: Move PinBuffer and UnpinBuffer to atomics
Next
From: Anastasia Lubennikova
Date:
Subject: Re: [PROPOSAL] Covering + unique indexes.