From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sun, 13 Nov 2016 18:12:35 +0000 (-0500)
Subject: Doc: remove obsolete example.
X-Git-Tag: REL9_6_2~135
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6f932cac7a20995e07d8c546143c45793a5072a0;p=postgresql

Doc: remove obsolete example.

The documentation for ts_headline() recommends using a sub-select to
avoid extra evaluations of ts_headline() in a query with ORDER BY+LIMIT.
Since commit 9118d03a8 this contortionism is unnecessary, so remove the
recommendation.  Noted by Oleg Bartunov.

Discussion: <CAF4Au4w6rrH_j1bvVhzpOsRiHCog7sGJ3LSX0tY8ZdwhHT88LQ@mail.gmail.com>
---

diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml
index 5a70d7db80..2da75955d0 100644
--- a/doc/src/sgml/textsearch.sgml
+++ b/doc/src/sgml/textsearch.sgml
@@ -1290,19 +1290,7 @@ query.',
    <para>
     <function>ts_headline</> uses the original document, not a
     <type>tsvector</type> summary, so it can be slow and should be used with
-    care.  A typical mistake is to call <function>ts_headline</function> for
-    <emphasis>every</emphasis> matching document when only ten documents are
-    to be shown. <acronym>SQL</acronym> subqueries can help; here is an
-    example:
-
-<programlisting>
-SELECT id, ts_headline(body, q), rank
-FROM (SELECT id, body, q, ts_rank_cd(ti, q) AS rank
-      FROM apod, to_tsquery('stars') q
-      WHERE ti @@ q
-      ORDER BY rank DESC
-      LIMIT 10) AS foo;
-</programlisting>
+    care.
    </para>
 
   </sect2>