Re: Examples Missing

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: shantanujain18(at)gmail(dot)com, pgsql-docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Examples Missing
Date: 2024-08-27 08:57:42
Message-ID: 1375FA21-3DEA-46B4-9997-F7E12968DE00@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 26 Aug 2024, at 22:16, PG Doc comments form <noreply(at)postgresql(dot)org> wrote:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/app-pgdump.html
> Description:
>
> Examples should be added for every option available for pg_dump. I was
> looking for example for on-conflict-do-nothing, and rows-per-insert and what
> does nrows do?

Even with examples for every option we are unlikely to cover all combinations
that anyone would like to see. I do think it would be good if we made sure to
mention the parameter name in the description to avoid any confusion.
Something like:

- <command>INSERT</command> command. The value specified must be a
+ <command>INSERT</command> command to be <replaceable>nrows</replaceable>. The value specified must be a

There are many more options without parameters named in the description though.

--
Daniel Gustafsson

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2024-08-28 06:37:05 Re: Incorrect option name for meson build
Previous Message PG Doc comments form 2024-08-27 05:35:26 Query in CTAS accepts optional parentheses not documented