Horton

Re: doc: pg_trgm missing description for GUC "pg_trgm.strict_word_similarity_threshold"

Ian Barwick <ian.barwick@2ndquadrant.com>

View thread View on postgr.es
From: Ian Barwick <ian.barwick@2ndquadrant.com>
To: Michael Paquier <michael@paquier.xyz>, Masahiko Sawada <sawada.mshk@gmail.com>
Cc: "pgsql-hackers@postgresql.org" <pgsql-hackers@postgresql.org>, Alexander Korotkov <a.korotkov@postgrespro.ru>
Date: 2019-06-07T15:02:04Z
Lists: pgsql-hackers

Attachments

On 6/7/19 9:00 PM, Michael Paquier wrote:
> On Fri, Jun 07, 2019 at 03:44:14PM +0900, Masahiko Sawada wrote:
>> BTW while looking GUC variables defined in trgm_op.c the operators in
>> each short description seems not correct; there is an extra percent
>> sign. Should we also fix them?
> 
> Both of you are right here

I did notice the double percent signs but my brain skipped over them
assuming they were translatable strings, thanks for catching that.

> and the addition documentation looks fine to me (except the indentation).

The indentation in the additional documentation seems fine to me, it's
the section for the preceding GUC which is offset one column to the right.
Patch attached for that.

 > The fix for the parameter descriptions can be back-patched safely as they
 > would reload correctly once the version is updated.

Yup, they would appear the first time one of the pg_trgm functions is called
in a session after the new object file is installed.

 > Or is that not worth bothering except on HEAD?  Thoughts?

Personally I don't think it's that critical, but not bothered either way.
Presumably no-one has complained so far anyway (I only chanced upon the missing
GUC description because I was poking about looking for examples of custom
GUC handling...)


Regards

Ian Barwick

-- 
  Ian Barwick                   https://www.2ndQuadrant.com/
  PostgreSQL Development, 24x7 Support, Training & Services

Commits

  1. Remove pg_trgm.strict_word_similarity_threshold doc from 9.6 and 10

  2. Add docs of missing GUC to pgtrgm.sgml

  3. Fix docs indentation in pgtrgm.sgml

  4. Fix operator naming in pg_trgm GUC option descriptions

  5. Add strict_word_similarity to pg_trgm module