Re: proposal: convert comments in documents to html comments

From: Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>
To: Noboru Saito <noborusai(at)gmail(dot)com>, Michael Paquier <michael(at)paquier(dot)xyz>
Cc: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, Peter Geoghegan <pg(at)bowt(dot)ie>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: proposal: convert comments in documents to html comments
Date: 2022-06-29 12:33:08
Message-ID: 6f9cc655-04a7-6d95-4cfe-46c1ec8ca70e@enterprisedb.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 29.06.22 09:29, Noboru Saito wrote:
> Comments aren't really associated with anything, so it's difficult to
> associate them correctly.
>
> I think it is better to stop commenting xml (sgml) and format it as
> follows (tags are tentative).

Yeah, with the exception of the release notes, XML comments were written
with the understanding that they are source-level comments, not
something that gets forwarded to the output. So let's leave comments be
comments, and if there is anything we want to include in the output,
let's mark it up properly.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2022-06-29 20:45:11 How to reference the type of lock in the documentation.
Previous Message Noboru Saito 2022-06-29 07:29:23 Re: proposal: convert comments in documents to html comments