Re: Doc reference of contrib modules

Tom Lane wrote:
> Bruce Momjian <bruce(at)momjian(dot)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(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

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