Re: describe special values in GUC descriptions more consistently

Nathan Bossart <nathandbossart@gmail.com>

From: Nathan Bossart <nathandbossart@gmail.com>
To: Peter Smith <smithpb2250@gmail.com>
Cc: Daniel Gustafsson <daniel@yesql.se>, "David G. Johnston" <david.g.johnston@gmail.com>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>
Date: 2025-02-12T22:46:58Z
Lists: pgsql-hackers

Attachments

On Thu, Feb 13, 2025 at 09:02:30AM +1100, Peter Smith wrote:
> One last thing...
> 
> - gettext_noop("Zero logs all files. The default is -1 (turning this
> feature off)."),
> + gettext_noop("-1 disables temporary file logs. 0 means log all
> temporary files."),
> 
> The first sentence could be ambiguous. E.g. "temporary file logs"
> might be interpreted as meaning logs about temporary files, or about
> temporary logs of files.
> 
> I think it should be worded more like the second sentence.
> e.g. "-1 disables logging temporary files. 0 means log all temporary files."
> 
> And doing this will be consistent with others you already have:
> + gettext_noop("-1 disables logging statement durations. 0 means log
> all statement durations."),
> + gettext_noop("-1 disables logging autovacuum actions. 0 means log
> all autovacuum actions."),

Good catch.  I've fixed that in v5.

-- 
nathan

Commits

  1. Adjust auto_explain's GUC descriptions.

  2. Describe special values in GUC descriptions more consistently.