From: Michael Paquier <michael@paquier.xyz>
To: Noboru Saito <noborusai@gmail.com>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: proposal: convert comments in documents to html comments
Date: Mon, 27 Jun 2022 09:12:34 +0900
Message-ID: <Yrj18lS0BhAMltuu@paquier.xyz> (raw)
In-Reply-To: <CAAM3qnLMh19gXBCa6QME_=p6UTNXajpvyoJm3DLZEcfKiC3rzA@mail.gmail.com>
References: <CAAM3qnLMh19gXBCa6QME_=p6UTNXajpvyoJm3DLZEcfKiC3rzA@mail.gmail.com>
On Sun, Jun 26, 2022 at 09:19:21PM +0900, Noboru Saito wrote:
> Currently the comments in the document are removed when converting to html.
> I propose to keep them as html comments.
OK. The format of the HTML pages is rather clean, so this would be
rather readable.
> The release notes have the git commit information in the comments,
> it would be great to have it in the html comments as well.
>
> That can be done with the attached patch.
One argument that could go against that is the extra amount of data it
generates in the page that gets loaded. How do things change for the
release notes? But we are likely talking about an increase of 70kB to
perhaps 100kB, so it does not matter much those days :)
Another is that you cannot notice those comments except when looking
at the HTML source, which is something that most users won't really
notice, while others willing to look at those particular commits could
just ping this information from the SGML files, because they should
have the code around anyway.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../Yrj18lS0BhAMltuu@paquier.xyz/2-signature.asc)
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: michael@paquier.xyz, noborusai@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: proposal: convert comments in documents to html comments
In-Reply-To: <Yrj18lS0BhAMltuu@paquier.xyz>
* 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