From: Bruce Momjian <bruce@momjian.us>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Josh Kupershmidt <schmiddy@gmail.com>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Doc reference of contrib modules
Date: Tue, 25 Jan 2011 10:26:28 -0500 (EST)
Message-ID: <201101251526.p0PFQSt20748@momjian.us> (raw)
In-Reply-To: <21985.1295968626@sss.pgh.pa.us>
Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > That is an interesting case. I didn't mention "module" here because
> > above this ia a dblink() function call, and we are referencing the
> > function call in the text. I couldn't figure out how to mention
> > "module" here without making the text more complex. I thought of:
>
> > The <link linkend="CONTRIB-DBLINK">dblink</> function (part of the
> > dblink module) executes a remote query.
>
> > but that seems awkward. Ideas?
>
> That's not just awkward, but flat wrong, because the link points to
> documentation of the module not the function. Correct would be
> something like
>
> The <function>dblink()</> function (part of the
> <link linkend="CONTRIB-DBLINK">dblink</> module) executes a remote query.
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.)
--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com
+ It's impossible for everything to be true. +
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients from your mail client; the link fills in
the headers below: reply via email
Some clients, webmail especially, drop In-Reply-To and References from
a link, and the reply then starts a new thread: use the mbox below.
To: pgsql-docs@postgresql.org
Cc: bruce@momjian.us, tgl@sss.pgh.pa.us, schmiddy@gmail.com
Subject: Re: Doc reference of contrib modules
In-Reply-To: <201101251526.p0PFQSt20748@momjian.us>
References: <21985.1295968626@sss.pgh.pa.us> <201101251526.p0PFQSt20748@momjian.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox