Re: proposal: convert comments in documents to html comments

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Noboru Saito <noborusai(at)gmail(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: proposal: convert comments in documents to html comments
Date: 2022-06-27 00:12:34
Message-ID: Yrj18lS0BhAMltuu@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Geoghegan 2022-06-27 00:23:44 Re: proposal: convert comments in documents to html comments
Previous Message Noboru Saito 2022-06-26 12:19:21 proposal: convert comments in documents to html comments