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

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

            regards, tom lane

pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: Doc reference of contrib modules
Next
From: Bruce Momjian
Date:
Subject: Re: Doc reference of contrib modules