From: PG Doc comments form <noreply@postgresql.org>
To: pgsql-docs@lists.postgresql.org
Cc: brittag@gmail.com
Subject: ts_headline performance note
Date: Fri, 29 Mar 2024 23:26:02 +0000
Message-ID: <171175476214.7104.6233899851600749789@wrigleys.postgresql.org> (raw)
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/16/textsearch-controls.html
Description:
My team recently ran into a performance issue that turned out to involve
ts_headline, so I've been looking at the documentation. In 12.3.4.
Highlighting Results, the last line says: "ts_headline uses the original
document, not a tsvector summary, so it can be slow and should be used with
care."
This sentence was easy for me to miss at first because it's a small line
between a long example block and the footer material. If a person needs to
use this with care, should that note be incorporated into the introduction
to the section?
Also, I see at
https://github.com/postgres/postgres/commit/d5d8a0b7e54ca09d0b5fdfc6afcb307450f33215
(discussed at
https://www.postgresql.org/message-id/6700.1478986625%40sss.pgh.pa.us) that
this section previously provided an example that became obsolete. "Used with
care" is a bit vague on its own, and future readers could benefit from a
more specific statement or a new example of how to use it with care.
Thank you very much! I appreciate the work of documentation editors.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: noreply@postgresql.org, pgsql-docs@lists.postgresql.org, brittag@gmail.com
Subject: Re: ts_headline performance note
In-Reply-To: <171175476214.7104.6233899851600749789@wrigleys.postgresql.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox