Re: Doc reference of contrib modules - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Doc reference of contrib modules
Date
Msg-id 201101251526.p0PFQSt20748@momjian.us
Whole thread Raw
In response to Re: Doc reference of contrib modules  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Doc reference of contrib modules  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
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. +

pgsql-docs by date:

Previous
From: Tom Lane
Date:
Subject: Re: Doc reference of contrib modules
Next
From: Tom Lane
Date:
Subject: Re: Doc reference of contrib modules