protocol-message-formats <- display format

Started by PG Bug reporting formover 7 years ago4 messagesdocs
Beta feature

Hackorum builds and tests every patch posted to the lists, not only commitfest submissions. This is Hackorum's own CI rather than the PostgreSQL project's, and it is still under testing - please report anything that looks wrong.

never appliedCI history
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
Description:

Hi,

It would improve the readability if we add further tabulation to the
description of each message.
Also, make the message title bold to visually distinguish it from the
description.

I would gladly modify the css to make this happen.

#2Jonathan S. Katz
jkatz@postgresql.org
In reply to: PG Bug reporting form (#1)
Re: protocol-message-formats <- display format

On 1/8/19 2:33 PM, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
Description:

Hi,

It would improve the readability if we add further tabulation to the
description of each message.
Also, make the message title bold to visually distinguish it from the
description.

I would gladly modify the css to make this happen.

Looking at a version[1]https://web.archive.org/web/20180309050904/https://www.postgresql.org/docs/9.6/static/protocol-message-formats.html before the the redesign, it appears there was
further indentation, so yes, this should be added back in.

I believe the titles are used in other places with that style, so we'd
have to make sure any changes to that don't affect readability on other
pages.

Thanks,

Jonathan

[1]: https://web.archive.org/web/20180309050904/https://www.postgresql.org/docs/9.6/static/protocol-message-formats.html
https://web.archive.org/web/20180309050904/https://www.postgresql.org/docs/9.6/static/protocol-message-formats.html

#3Jonathan S. Katz
jkatz@postgresql.org
In reply to: Jonathan S. Katz (#2)
Re: protocol-message-formats <- display format

On 1/9/19 10:13 AM, Jonathan S. Katz wrote:

On 1/8/19 2:33 PM, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
Description:

Hi,

It would improve the readability if we add further tabulation to the
description of each message.
Also, make the message title bold to visually distinguish it from the
description.

I would gladly modify the css to make this happen.

Looking at a version[1] before the the redesign, it appears there was
further indentation, so yes, this should be added back in.

Attached is a patch to correct this. I tested several pages that are
affected by the "VARIABLELIST" style in multiple versions, and it
appears to be an overall improvement.

I will apply to pgweb shortly.

Thanks,

Jonathan

Attachments:

0001-Add-further-indentation-to-variable-lists-to-disting.patchtext/plain; charset=UTF-8; name=0001-Add-further-indentation-to-variable-lists-to-disting.patch; x-mac-creator=0; x-mac-type=0Download+15-1
#4Leonardo De la Cerda
leobiwankenobi@gmail.com
In reply to: Jonathan S. Katz (#3)
Re: protocol-message-formats <- display format

That's awesome!

Thanks

On Wed, Jan 9, 2019 at 7:34 AM Jonathan S. Katz <jkatz@postgresql.org>
wrote:

Show quoted text

On 1/9/19 10:13 AM, Jonathan S. Katz wrote:

On 1/8/19 2:33 PM, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/protocol-message-formats.html
Description:

Hi,

It would improve the readability if we add further tabulation to the
description of each message.
Also, make the message title bold to visually distinguish it from the
description.

I would gladly modify the css to make this happen.

Looking at a version[1] before the the redesign, it appears there was
further indentation, so yes, this should be added back in.

Attached is a patch to correct this. I tested several pages that are
affected by the "VARIABLELIST" style in multiple versions, and it
appears to be an overall improvement.

I will apply to pgweb shortly.

Thanks,

Jonathan