Feedback-ID: i0fe9450f:Fastmail
Date: Mon, 27 Jun 2022 09:12:34 +0900
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
Message-ID: <Yrj18lS0BhAMltuu@paquier.xyz>
References: 
 <CAAM3qnLMh19gXBCa6QME_=p6UTNXajpvyoJm3DLZEcfKiC3rzA@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="YYd7Ta+Tn9zaUCA5"
Content-Disposition: inline
In-Reply-To: 
 <CAAM3qnLMh19gXBCa6QME_=p6UTNXajpvyoJm3DLZEcfKiC3rzA@mail.gmail.com>
Archived-At: 
 <https://www.postgresql.org/message-id/Yrj18lS0BhAMltuu%40paquier.xyz>
Precedence: bulk


--YYd7Ta+Tn9zaUCA5
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Sun, Jun 26, 2022 at 09:19:21PM +0900, Noboru Saito wrote:
> Currently the comments in the document are removed when converting to htm=
l.
> 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.
>=20
> 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

--YYd7Ta+Tn9zaUCA5
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmK49fIACgkQnvQgOdby
QH3D3w/8CykuaXniI2i7CCWLyCfFi1h0b9cjaV8YeDkvObpZhre3B9aWPvPJaAxa
IQocBY5nx5u/rjYTsnbX+9pYr+P6fnFd4YHcHS2JNDUSqT0X0z5jFcN2+c9g4NA0
sntOiSAW0r5W9RN1ZtHt/7pnQTmEckmDPNK1am9Ap0MGvgBQbaj+12sS5gU+ClwJ
rxt/1gODvvZZqosKa/KmX9WErdqwnHkhyn60kOfI02HDMm9AH2Oj51XYadNZhvyh
j6EanSK+6GV3ZAVG8WxZNA0tNmvk5jW2lqLAYLUVBvBG5P8iXuUsme8nPthXbDHq
aX4pJ/oAIm+2Pjp8QNymMPXbfFCHVL+x4mg+Y2Pwt4uQnVvjYhuFoLM/3tzLv1hh
+je394RpFGfQ2KTgLzkRBNUprZBThz5S7f/vq9ybmgZWRhAIdjU6kNfL6iPQl7/e
OYHrr/5N6lWKqJXNxTuxShK6qjXgMWxq4vA6TVbHx4SaKPorZYB6jH0JfHdqf5rY
6vSCMikagqZvkUGwqOdwPCgwSTe0go6LrodvLduUIX0ZWbM5nYWjAQwxlagxzoQE
4bXbLZwzW+bGu0IKJI/pJLXweEVpQGsQ1MYgNpV6abFdSWR/6+w5qL/APhD80doE
+LV1lSUE0Hhtr7wI08KRBpXmTEPRmt3W3D18oRWyuXq6WCAA+Fs=
=J3xw
-----END PGP SIGNATURE-----

--YYd7Ta+Tn9zaUCA5--