Re: Syntax diagrams in user documentation

From: Christopher Browne <cbbrowne(at)gmail(dot)com>
To: Peter Geoghegan <pg(at)bowt(dot)ie>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Syntax diagrams in user documentation
Date: 2019-03-28 22:35:20
Message-ID: CAFNqd5VxLLM+QikD7QNZ=Lq8myd+xcAvhMjCrr-1ZWX=Eq1AFQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, 28 Mar 2019 at 17:56, Peter Geoghegan <pg(at)bowt(dot)ie> wrote:

> SQLite has a bubble generator tool that they use to generate syntax
> diagrams for their documentation:
>
>
> https://www.sqlite.org/docsrc/doc/tip/art/syntax/bubble-generator.tcl?mimetype=text/plain
>
> I think that the results are rather good. See, for example, the INSERT
> documentation:
>
> https://www.sqlite.org/lang_insert.html
>

neato!

(And no coincidence that GraphViz has a command by that name...
https://www.graphviz.org/pdf/neatoguide.pdf)

An especially cool idea if we could automatically dig input directly from
src/backend/parser/gram.y
--
When confronted by a difficult problem, solve it by reducing it to the
question, "How would the Lone Ranger handle this?"

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2019-03-28 22:38:04 Re: speeding up planning with partitions
Previous Message Alvaro Herrera 2019-03-28 22:25:00 Re: Syntax diagrams in user documentation