A propose to revise \watch help message

Lists: pgsql-hackers
From: Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com>
To: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: A propose to revise \watch help message
Date: 2023-08-30 01:21:26
Message-ID: 20230830.102126.1847311533056115336.horikyota.ntt@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Recently \watch got the following help message.

> \watch [[i=]SEC] [c=N] [m=MIN]
> execute query every SEC seconds, up to N times
> stop if less than MIN rows are returned

The "m=MIN" can be a bit misleading. It may look like it's about
interval or counts, but it actually refers to the row number, which is
not spelled out in the line.

Would it make sense to change it to MINROWS? There's enough room in
the line for that change and the doc already uses min_rows.

regards.

--
Kyotaro Horiguchi
NTT Open Source Software Center

Attachment Content-Type Size
watch_help_MIN_to_MINROWS.patch text/x-patch 806 bytes

From: Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com>
To: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: A propose to revise \watch help message
Date: 2023-08-30 01:33:56
Message-ID: 20230830.103356.1909699532104167477.horikyota.ntt@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

At Wed, 30 Aug 2023 10:21:26 +0900 (JST), Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com> wrote in
> Recently \watch got the following help message.
>
> > \watch [[i=]SEC] [c=N] [m=MIN]
> > execute query every SEC seconds, up to N times
> > stop if less than MIN rows are returned
>
> The "m=MIN" can be a bit misleading. It may look like it's about
> interval or counts, but it actually refers to the row number, which is
> not spelled out in the line.
>
> Would it make sense to change it to MINROWS? There's enough room in
> the line for that change and the doc already uses min_rows.

Mmm. I noticed the continuation lines are indented too much, probably
because of the backslash escape in the main line. The attached
includes the fix for that.

regards.

--
Kyotaro Horiguchi
NTT Open Source Software Center

Attachment Content-Type Size
watch_help_MIN_to_MINROWS_2.patch text/x-patch 891 bytes