confusing positioning of notes in connection settings - Mailing list pgsql-docs

From Jonathan S. Katz
Subject confusing positioning of notes in connection settings
Date
Msg-id 6f825d42-a1ce-492a-2ea7-c83e6e65fa8b@postgresql.org
Whole thread Raw
Responses Re: confusing positioning of notes in connection settings  (Peter Eisentraut <peter.eisentraut@enterprisedb.com>)
List pgsql-docs
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-COUNT

Attachment

pgsql-docs by date:

Previous
From: Fujii Masao
Date:
Subject: Re: documentation for PGLOADBALANCEHOSTS environment variable in libpq
Next
From: Peter Eisentraut
Date:
Subject: Re: confusing positioning of notes in connection settings