Skip to content

Commit 727f0dc

Browse files
committed
Documentation improvements
* Use actual function name in section id * More descriptive title * Explain what expression the function computes and that's a boolean * GIST -> GiST
1 parent 07cfeef commit 727f0dc

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/functions.sgm

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@
149149
</example>
150150
</sect2>
151151

152-
<sect2 id="func.spoint.dist">
152+
<sect2 id="func.spoint_dwithin">
153153
<title>
154-
Point distance function
154+
Point-within-distance function
155155
</title>
156156
<para>
157157
The function
@@ -166,8 +166,9 @@
166166
</funcsynopsis>
167167
<para>
168168
returns if points <parameter>p1</parameter> and <parameter>p2</parameter>
169-
lie within distance <parameter>radius</parameter> of each other.
170-
On PostgreSQL 12 and later, the function has <literal>GIST</literal>
169+
lie within distance <parameter>radius</parameter> of each other, i.e.
170+
it computes the boolean expression <literal>p1 &lt;-> p2 &lt;= radius</literal>.
171+
On PostgreSQL 12 and later, the function has <literal>GiST</literal>
171172
support and the PostgreSQL optimizer will transform it to either
172173
<literal>p1 &lt;@ scircle(p2, radius)</literal> or
173174
<literal>p2 &lt;@ scircle(p1, radius)</literal> where appropriate.

0 commit comments

Comments
 (0)