pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedprotocol-message-formats <- display format
4+ messages / 3 participants
[nested] [flat]
* protocol-message-formats <- display format
@ 2019-01-08 19:33 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2019-01-08 19:33 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: leobiwankenobi@gmail.com
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.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: protocol-message-formats <- display format
@ 2019-01-09 15:13 Jonathan S. Katz <jkatz@postgresql.org>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: Jonathan S. Katz @ 2019-01-09 15:13 UTC (permalink / raw)
To: leobiwankenobi@gmail.com; pgsql-docs@lists.postgresql.org; +Cc: Sarah Schnurr <xenophenes42@gmail.com>
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.
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-messa...
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: protocol-message-formats <- display format
@ 2019-01-09 15:34 Jonathan S. Katz <jkatz@postgresql.org>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: Jonathan S. Katz @ 2019-01-09 15:34 UTC (permalink / raw)
To: leobiwankenobi@gmail.com; pgsql-docs@lists.postgresql.org; +Cc: Sarah Schnurr <xenophenes42@gmail.com>
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.patch (text/plain, 1.1K) download
From 79253866e3ff99047c6bc6e4b79da6ecbb4823c8 Mon Sep 17 00:00:00 2001
From: "Jonathan S. Katz" <jonathan.katz@excoventures.com>
Date: Wed, 9 Jan 2019 10:31:46 -0500
Subject: [PATCH] Add further indentation to variable lists to distinguish
groups.
This was an regression introduced by the new styles that affects
readability of nested variables lists (e.g. on the message protocol
page). This brings the look more in line with the previous documentation
styles and should help with readability.
---
media/css/main.css | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/media/css/main.css b/media/css/main.css
index 7b11456..c0cf16d 100644
--- a/media/css/main.css
+++ b/media/css/main.css
@@ -941,6 +941,21 @@ code,
font-weight: 300;
}
+#docContent .VARIABLELIST dt,
+#docContent .variablelist dt {
+ font-family: monospace;
+ font-weight: 300;
+}
+
+#docContent .variablelist dd {
+ margin-top: 1rem;
+}
+
+#docContent .VARIABLELIST dd,
+#docContent .variablelist dd {
+ margin-inline-start: 2rem;
+}
+
#docContent ul.itemizedlist {
margin-left: 2.5rem;
}
--
2.14.3 (Apple Git-98)
* Re: protocol-message-formats <- display format
@ 2019-01-09 16:01 Leonardo De la Cerda <leobiwankenobi@gmail.com>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 0 replies; 4+ messages in thread
From: Leonardo De la Cerda @ 2019-01-09 16:01 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: pgsql-docs@lists.postgresql.org, Sarah Schnurr <xenophenes42@gmail.com>
That's awesome!
Thanks
On Wed, Jan 9, 2019 at 7:34 AM Jonathan S. Katz <jkatz@postgresql.org>
wrote:
> 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
>
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2019-01-09 16:01 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-01-08 19:33 protocol-message-formats <- display format PG Doc comments form <noreply@postgresql.org>
2019-01-09 15:13 ` Jonathan S. Katz <jkatz@postgresql.org>
2019-01-09 15:34 ` Jonathan S. Katz <jkatz@postgresql.org>
2019-01-09 16:01 ` Leonardo De la Cerda <leobiwankenobi@gmail.com>
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