Re: Possibly hard-to-read message - Mailing list pgsql-hackers

From David G. Johnston
Subject Re: Possibly hard-to-read message
Date
Msg-id CAKFQuwbV7kD-v-SYjyQTvxOUui5HkRcXO4RoMNnbPaDL=Bw0WQ@mail.gmail.com
Whole thread Raw
In response to Re: Possibly hard-to-read message  (Daniel Gustafsson <daniel@yesql.se>)
Responses Re: Possibly hard-to-read message
List pgsql-hackers
On Wed, Mar 26, 2025 at 2:11 AM Daniel Gustafsson <daniel@yesql.se> wrote:
On 26 Mar 2025, at 04:52, David G. Johnston <david.g.johnston@gmail.com> wrote:
On Tue, Mar 25, 2025 at 8:07 PM Kyotaro Horiguchi <horikyota.ntt@gmail.com> wrote:

I came across the following help message added in commit 1a759c83278:

+       HELP0("  WATCH_INTERVAL\n"
+                 "    number of seconds \\watch by default waits between executing the query buffer\n");

It took me a little while to understand it.

I'm on board with tweaking this.

How about the attached?  We already have "(default: X)" in other places so this
aligns it better while simplifying the language.


This change is technically wrong on two points:

I pondered mentioning the 2s interval but the environment variable itself doesn't have a default, it's either set or unset which determines whether it provides the default or not.  IMO, adding this detail produces too much text for little benefit.

Your wording loses the idea that this environment variable only establishes a new default that can be subsequently overridden by explicitly specifying an interval to \watch.

David J.

pgsql-hackers by date:

Previous
From: Michael Paquier
Date:
Subject: Re: A small correction to doc and comment of FSM for indexes
Next
From: Yurii Rashkovskii
Date:
Subject: Re: Add Postgres module info