Re: proposal: convert comments in documents to html comments

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>
Cc: Noboru Saito <noborusai(at)gmail(dot)com>, Michael Paquier <michael(at)paquier(dot)xyz>, 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-07-05 19:48:44
Message-ID: YsSVnIx5N5QU+/I+@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Wed, Jun 29, 2022 at 01:33:08PM +0100, Peter Eisentraut wrote:
> 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.

I can add that markup, instead of SGML comments, when I create the
release notes.

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

Indecision is a decision. Inaction is an action. Mark Batterson

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2022-07-07 00:27:01 Typo in examples in "8.14.5. jsonb Subscripting"
Previous Message PG Doc comments form 2022-06-30 16:15:51 Query planner documentation should mention xxx_collapse_limit parameters