Re: Railroad diagrams, a-la sqlite - Mailing list pgsql-docs

From Thom Brown
Subject Re: Railroad diagrams, a-la sqlite
Date
Msg-id AANLkTikzQCj8kJPAINMSGjypjKbWxmcXe2WqWqeenKxU@mail.gmail.com
Whole thread Raw
In response to Railroad diagrams, a-la sqlite  (Steve Atkins <steve@blighty.com>)
Responses Re: Railroad diagrams, a-la sqlite  (Dave Page <dpage@pgadmin.org>)
List pgsql-docs
On 17 July 2010 05:33, Steve Atkins <steve@blighty.com> wrote:
> Has everyone seen the "railroad diagrams" sqlite use in their docs? http://www.sqlite.org/lang_createindex.html , as
oneexample. 
>
> Would it be nice to have the same sort of format in the postgresql docs? (Yeah, I'm volunteering, if people think
they'rea useful thing, 'cos I think they'd add a lot to our documentation.) 
>
> Cheers,
>  Steve
>

While they're quite attractive, I actually see them being more
confusing than helpful personally, but I could be wrong.  I reckon
there might be clearer ways of representing statement options.  The
real problems with the railroad design come when there are lots of
references to other diagrams, and you end up with about 10 just for 1
statement.

Is there a way of testing their usefulness?

Thom

pgsql-docs by date:

Previous
From: Peter Eisentraut
Date:
Subject: Re: Railroad diagrams, a-la sqlite
Next
From: Dave Page
Date:
Subject: Re: Railroad diagrams, a-la sqlite