pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Examples Missing
2+ messages / 2 participants
[nested] [flat]

* Examples Missing
@ 2024-08-26 20:16 PG Doc comments form <noreply@postgresql.org>
  2024-08-27 08:57 ` Re: Examples Missing Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 1 reply; 2+ messages in thread

From: PG Doc comments form @ 2024-08-26 20:16 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org; +Cc: shantanujain18@gmail.com

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?


^ permalink  raw  reply  [nested|flat] 2+ messages in thread

* Re: Examples Missing
  2024-08-26 20:16 Examples Missing PG Doc comments form <noreply@postgresql.org>
@ 2024-08-27 08:57 ` Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 0 replies; 2+ messages in thread

From: Daniel Gustafsson @ 2024-08-27 08:57 UTC (permalink / raw)
  To: shantanujain18@gmail.com, pgsql-docs <pgsql-docs@lists.postgresql.org>

> On 26 Aug 2024, at 22:16, PG Doc comments form <noreply@postgresql.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






^ permalink  raw  reply  [nested|flat] 2+ messages in thread


end of thread, other threads:[~2024-08-27 08:57 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2024-08-26 20:16 Examples Missing PG Doc comments form <noreply@postgresql.org>
2024-08-27 08:57 ` Daniel Gustafsson <daniel@yesql.se>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox