| From: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
|---|---|
| To: | Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> |
| Cc: | PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: Adding an explaining title to Notes on SGML |
| Date: | 2026-04-23 07:55:28 |
| Message-ID: | 778F991A-3BF8-4618-8F2E-3C503063F650@yesql.se |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
> On 22 Apr 2026, at 20:59, Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> wrote:
>
> I noticed that a "This" was missing when reading the Notes of the Aggregates page, so I thought... wouldn't it be better if we had a title in some of the Notes ?
> Because in many cases, like this example, you have a huge table and below it a Notes. But what is this Notes talking about ?
Notes are IMHO useful when they cause the reader to reflect on the <para> they
just read.
I think it's an antipattern to have notes so far removed from the relevant
<para> that we need a title for it. A reader looking for info on count() will
find it in the table and read it - we can't really expect them to keep
scrolling a few pages down to see if there might be more info that wasn't
linked to.
Wouldn't it make more sense to refactor to move the information in the note
closer to what the note is regarding?
--
Daniel Gustafsson
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Richard Guo | 2026-04-23 07:58:46 | Re: The bogus calls in remove_self_join_rel() |
| Previous Message | Michael Paquier | 2026-04-23 07:44:06 | Re: Fix memory leak in postmasterMain |