Re: A minor bug in doc. Hovering over heading shows # besides it.

From: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: David Rowley <dgrowleyml(at)gmail(dot)com>, Muhammad Ikram <mmikram(at)gmail(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: A minor bug in doc. Hovering over heading shows # besides it.
Date: 2024-07-18 18:03:40
Message-ID: c2e3bc0c-5717-4268-b4bd-c1b88a5c0799@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 7/18/24 1:59 PM, Daniel Gustafsson wrote:
>> On 18 Jul 2024, at 15:49, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>>
>> Daniel Gustafsson <daniel(at)yesql(dot)se> writes:
>>> While not a standard the pilcrow [0] is, AFAICT from a bit of looking at other
>>> docs, commonly used for this. There is a lot of variability though so
>>> whichever we choose it will be wrong one for someone.
>>
>> I like this suggestion better because that's U+00B6, ie part of
>> LATIN-1, so it's *far* more likely to render correctly everywhere
>> than U+01F517 is. We could also consider the section sign §
>> (U+00A7).
>>
>> In any case, a tooltip would help reduce confusion.
>
> Looking a bit closer, the Python documentation does just this, a pilcrow with a
> tool-tip ("Link to this heading") when hovering over it

I forgot why we went with the "#" and not the (TIL the name) pilcrow
symbol, but I'm generally used to seeing the pilcrow when I browse docs
and may have voiced that at the time (though the record may show
otherwise). So +1 to that.

Thanks,

Jonathan

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message 日向充 2024-07-19 01:46:04 A minor bug in the doc of "SQL Functions Returning Sets" in xfunc.sgml.
Previous Message Tom Lane 2024-07-18 18:03:08 Re: A minor bug in doc. Hovering over heading shows # besides it.