Re: Better visualization of default values

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>
Cc: Peter Smith <smithpb2250(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Better visualization of default values
Date: 2025-02-06 15:34:13
Message-ID: CAKFQuwZ=Amu9EqJ0WGdFKDkC5EnbTBjnLzJtNXpnxXBhGYpGww@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, Feb 6, 2025 at 4:46 AM Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> wrote:

> Objective here is to those ones who know what it is, but don't
> remember its default.
>

My approach would be to add a summary table (or tables) in the first
subsection of each major X.Y (section X.Y.1) that lists the name, brief
description, type, default value, and notes. Then just leave the full
descriptions self-contained as they are. Pure redundancy but basically put
the output of a psql meta-command directly into the docs.

Between these other two choices I'd lean toward placing the default only
next to the data type.

David J.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Alexander Borisov 2025-02-06 15:39:08 Re: Optimization for lower(), upper(), casefold() functions.
Previous Message Greg Sabino Mullane 2025-02-06 15:31:27 Re: Better visualization of default values