Re: proposal: convert comments in documents to html comments - Mailing list pgsql-docs

From Michael Paquier
Subject Re: proposal: convert comments in documents to html comments
Date
Msg-id Yrj18lS0BhAMltuu@paquier.xyz
Whole thread Raw
In response to proposal: convert comments in documents to html comments  (Noboru Saito <noborusai@gmail.com>)
Responses Re: proposal: convert comments in documents to html comments  (Peter Geoghegan <pg@bowt.ie>)
List pgsql-docs
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

Attachment

pgsql-docs by date:

Previous
From: Noboru Saito
Date:
Subject: proposal: convert comments in documents to html comments
Next
From: Peter Geoghegan
Date:
Subject: Re: proposal: convert comments in documents to html comments