Re: Example not producing shown output

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
Cc: Daniel Gustafsson <daniel(at)yesql(dot)se>, miodrag(dot)milic(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Example not producing shown output
Date: 2019-12-18 03:27:33
Message-ID: 20191218032733.GH30116@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Thu, Nov 28, 2019 at 11:22:20AM -0300, Alvaro Herrera wrote:
> On 2019-Nov-27, Daniel Gustafsson wrote:
>
> > > On 26 Nov 2019, at 19:28, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com> wrote:
> >
> > > Or perhaps we can add a second line in the example cell for the
> > > @@ operator, to make it clear that both forms can be used. Users can be
> > > expected to apply some intuition from that point onwards.
> >
> > Wouldn't it be more intuitive to add such a second line under to_tsvector, or
> > expand the Description field to cover a brief discussion covering this?
>
> I don't know. The problem is that the line for to_tsvector is a lot
> further down the page in table 9.42, and it contains a lot of other
> stuff, so people trying their first examples based on table 9.41 would
> not see it and will be as surprised as the OP was when it doesn't work
> under their locale.
>
> I think enlarging the description for the @@ entry is not out of the
> question, but trying to explain too much about the locale there seems a
> bit out of place. This is why I suggested to add another Note box below
> the table.
>
> If I misunderstood what you meant, please be more specific.

Would adding more doc places where we set the session language to
English help here, rather than doing it in the function calls?

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

+ As you are, so once was I. As I am, so you will be. +
+ Ancient Roman grave inscription +

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2019-12-18 18:07:18 Re: client auth docs seem to have devolved
Previous Message Bruce Momjian 2019-12-18 00:16:39 Re: documentation clarifications for "alter sequence" ?