Re: Doc reference of contrib modules

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Josh Kupershmidt <schmiddy(at)gmail(dot)com>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Doc reference of contrib modules
Date: 2011-01-25 15:57:28
Message-ID: 201101251557.p0PFvSj25427@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Tom Lane wrote:
> Bruce Momjian <bruce(at)momjian(dot)us> writes:
> > Tom Lane wrote:
> >> That's not just awkward, but flat wrong, because the link points to
> >> documentation of the module not the function.
>
> > The tag for the dblink module is:
>
> > <sect1 id="dblink">
>
> > the function's tag is:
>
> > <refentry id="CONTRIB-DBLINK">
>
> > so I believe the text in the patch is correct. (Yes, I realize those
> > are confusing tags.)
>
> Oh. Please change the function's tag to something a bit saner while
> you're messing around with this, FUNCTION-DBLINK perhaps?

OK, done in attached patch. (Git does allow easier incremental patch
generation.)

> I still think that a link to the contrib module's page would be a good
> thing to provide here.

Yep, but how to do it in a clear way?

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ It's impossible for everything to be true. +

Attachment Content-Type Size
/rtmp/dblink.diff text/x-diff 1.8 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2011-01-25 16:10:45 Re: Doc reference of contrib modules
Previous Message Tom Lane 2011-01-25 15:43:32 Re: Doc reference of contrib modules