Re: Introductory docs-hacking task: Example markup

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
Cc: Xavier Fischer <xavier_fischer(at)hotmail(dot)fr>, "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Introductory docs-hacking task: Example markup
Date: 2026-11-17 09:35:03
Message-ID: 91926DF0-A1FC-4F73-B39A-AEDD0003F1BA@yesql.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 17 Nov 2026, at 04:00, Matemática A3K <matematica(dot)a3k(at)gmail(dot)com> wrote:

> In other threads, it has been stated that the examples do not
> necessarily run, questions have been routed with that.

They will typically run (though I'm sure we have those that don't), but they
are not guaranteed to be complete examples. That's an important distinction
IMO, the syntax should be correct but an example might not list every partition
for a partition hierarchy for example. In such cases we could add what's
missing as a comment.

> That's another guideline, which one should be followed? See the problem?

I don't see a problem. I was merely trying to point out one potential upside
of rich markup, though perhaps this was an ill-chosen example.

--
Daniel Gustafsson

In response to

Browse pgsql-docs by date

  From Date Subject
Previous Message Daniel Gustafsson 2026-11-17 09:28:40 Re: Introductory docs-hacking task: Example markup