From: Jonathan S. Katz <jkatz@postgresql.org>
To: Pg Docs <pgsql-docs@lists.postgresql.org>
Subject: confusing positioning of notes in connection settings
Date: Sat, 22 Apr 2023 15:53:09 -0400
Message-ID: <6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org> (raw)
While testing a few other things on the connection settings page[1], I
noticed the notes on the "tcp_*" family of settings. While scrolling
further down the page, I found myself slightly confused over which note
corresponded to which setting (example in screenshot).
Given the nature of these notes, i.e. to say that the setting is not
supported in Windows, couldn't we just add that text to the description
of the parameter and remove the note? I think that'd make it a bit
clearer which comment applies to which parameter.
While arguably this is not a big deal now, the new deep-linking work for
v16[2] could make this a bit more confusing.
Thoughts?
Thanks,
Jonathan
[1]
https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-TCP-KEEPALIVES-COUNT
[2]
https://www.postgresql.org/docs/devel/runtime-config-connection.html#GUC-TCP-KEEPALIVES-COUNTAttachments:
[image/png] Screen Shot 2023-04-22 at 3.46.34 PM.png (119.7K, ../6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org/2-Screen%20Shot%202023-04-22%20at%203.46.34%20PM.png)
download | view image
[application/pgp-signature] OpenPGP_signature (839B, ../6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org/3-OpenPGP_signature)
download
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: jkatz@postgresql.org, pgsql-docs@lists.postgresql.org
Subject: Re: confusing positioning of notes in connection settings
In-Reply-To: <6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox