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

[Ian Barwick]

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

diff --git a/doc/src/sgml/pgtrgm.sgml b/doc/src/sgml/pgtrgm.sgml
index 83b0033d7a..e353ecc954 100644
--- a/doc/src/sgml/pgtrgm.sgml
+++ b/doc/src/sgml/pgtrgm.sgml
@@ -320,23 +320,23 @@
      </para>
     </listitem>
    </varlistentry>
-    <varlistentry id="guc-pgtrgm-word-similarity-threshold" xreflabel="pg_trgm.word_similarity_threshold">
-     <term>
-      <varname>pg_trgm.word_similarity_threshold</varname> (<type>real</type>)
-      <indexterm>
-       <primary>
-        <varname>pg_trgm.word_similarity_threshold</varname> configuration parameter
-       </primary>
-      </indexterm>
-     </term>
-     <listitem>
-      <para>
-       Sets the current word similarity threshold that is used by
-       <literal>&lt;%</literal> and <literal>%&gt;</literal> operators.  The threshold
-       must be between 0 and 1 (default is 0.6).
-      </para>
-     </listitem>
-    </varlistentry>
+   <varlistentry id="guc-pgtrgm-word-similarity-threshold" xreflabel="pg_trgm.word_similarity_threshold">
+    <term>
+     <varname>pg_trgm.word_similarity_threshold</varname> (<type>real</type>)
+     <indexterm>
+      <primary>
+       <varname>pg_trgm.word_similarity_threshold</varname> configuration parameter
+      </primary>
+     </indexterm>
+    </term>
+    <listitem>
+     <para>
+      Sets the current word similarity threshold that is used by
+      <literal>&lt;%</literal> and <literal>%&gt;</literal> operators.  The threshold
+      must be between 0 and 1 (default is 0.6).
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </sect2>