pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Little formatting issues in doc
5+ messages / 3 participants
[nested] [flat]

* Little formatting issues in doc
@ 2026-09-29 09:20  Oli Sennhauser <oli.sennhauser@fromdual.com>
  0 siblings, 1 reply; 5+ messages in thread

From: Oli Sennhauser @ 2026-09-29 09:20 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org

Hello all


Working with anonymous blocks I recently found a formatting issue which 
confused me at the first look:

DO $$DECLARE r record;
BEGIN

Source: 
https://www.postgresql.org/docs/current/sql-do.html#SQL-DO-EXAMPLES and 
~/src/postgresql/doc/src/sgml/ref/do.sgml


Suggested improvement:

DO $$
DECLARE
     r record;
BEGIN

Shall I write a patch for this? Anybody willing to look at a patch?

<programlisting>
DO $$
DECLARE
     r record;
BEGIN
     FOR r IN SELECT table_schema, table_name FROM information_schema.tables
              WHERE table_type = 'VIEW' AND table_schema = 'public'
     LOOP
         EXECUTE 'GRANT ALL ON ' || quote_ident(r.table_schema) || '.' 
|| quote_ident(r.table_name) || ' TO webuser';
     END LOOP;
END$$;
</programlisting></para>


Searching further for similar issues I found this:


RETURNS BOOLEAN AS $$
DECLARE passed BOOLEAN;
BEGIN

Same case. Shall I write a patch for this?

Source: https://www.postgresql.org/docs/current/sql-createfunction.html


Regards,
Oli

-- 

FromDual - Neutral and vendor independent MariaDB, MySQL and PostgreSQL services.

FromDual GmbH                     Rebenweg 6
CH - 8610 Uster
Oli Sennhauser                    CEO / Senior Consultant
Phone: +41 44 500 58 20           Mobile: +41 79 830 09 33
oli.sennhauser@fromdual.com       https://www.fromdual.com
Twitter: fromdual



Attachments:

  [application/pgp-keys] OpenPGP_0xB58CF11D3C9DDEA9.asc (1.7K, ../../777637c4-9d31-498d-a8ef-645fb510bf5a@fromdual.com/2-OpenPGP_0xB58CF11D3C9DDEA9.asc)
  download

  [application/pgp-signature] OpenPGP_signature.asc (494B, ../../777637c4-9d31-498d-a8ef-645fb510bf5a@fromdual.com/3-OpenPGP_signature.asc)
  download

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

* Re: Little formatting issues in doc
@ 2026-09-29 12:56  Daniel Gustafsson <daniel@yesql.se>
  parent: Oli Sennhauser <oli.sennhauser@fromdual.com>
  0 siblings, 1 reply; 5+ messages in thread

From: Daniel Gustafsson @ 2026-09-29 12:56 UTC (permalink / raw)
  To: Oli Sennhauser <oli.sennhauser@fromdual.com>; +Cc: pgsql-docs@lists.postgresql.org

> On 29 Sep 2026, at 11:20, Oli Sennhauser <oli.sennhauser@fromdual.com> wrote:

> Shall I write a patch for this? Anybody willing to look at a patch?

Please do (for both).

--
Daniel Gustafsson






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

* Re: Little formatting issues in doc
@ 2026-09-29 13:24  David Rowley <dgrowleyml@gmail.com>
  parent: Daniel Gustafsson <daniel@yesql.se>
  0 siblings, 1 reply; 5+ messages in thread

From: David Rowley @ 2026-09-29 13:24 UTC (permalink / raw)
  To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Oli Sennhauser <oli.sennhauser@fromdual.com>; pgsql-docs@lists.postgresql.org

On Wed, 30 Sept 2026 at 01:56, Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > On 29 Sep 2026, at 11:20, Oli Sennhauser <oli.sennhauser@fromdual.com> wrote:
>
> > Shall I write a patch for this? Anybody willing to look at a patch?
>
> Please do (for both).

Sorry, some crossfire here. I pushed the fix for the obviously broken
one. I didn't feel the need to standardise on "DECLARE" being on its
own line. There are other examples that declare the single variable on
the same line. Plenty of ones for cursors.

cd doc && git grep -E "^\s*DECLARE"

I feel like if we adjusted the "DECLARE passed BOOLEAN;" one, the
floodgates would open for the remainder.

David






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

* Re: Little formatting issues in doc
@ 2026-09-29 15:34  Oli Sennhauser <oli.sennhauser@fromdual.com>
  parent: David Rowley <dgrowleyml@gmail.com>
  0 siblings, 1 reply; 5+ messages in thread

From: Oli Sennhauser @ 2026-09-29 15:34 UTC (permalink / raw)
  To: David Rowley <dgrowleyml@gmail.com>; +Cc: pgsql-docs@lists.postgresql.org, Daniel Gustafsson <daniel@yesql.se>

OK. Thanks, David!

Question: How frequently is the documentation built and published?

 From the HTML code I can see something like this:

<meta property="article:published_time" 
content="2026-08-13T12:52:54.741344" />

which looks like: "Not daily".

Thanks,
Oli


On 29/09/2026 15:24, David Rowley wrote:
> On Wed, 30 Sept 2026 at 01:56, Daniel Gustafsson<daniel@yesql.se> wrote:
>>> On 29 Sep 2026, at 11:20, Oli Sennhauser<oli.sennhauser@fromdual.com> wrote:
>>> Shall I write a patch for this? Anybody willing to look at a patch?
>> Please do (for both).
> Sorry, some crossfire here. I pushed the fix for the obviously broken
> one. I didn't feel the need to standardise on "DECLARE" being on its
> own line. There are other examples that declare the single variable on
> the same line. Plenty of ones for cursors.
>
> cd doc && git grep -E "^\s*DECLARE"
>
> I feel like if we adjusted the "DECLARE passed BOOLEAN;" one, the
> floodgates would open for the remainder.
>
> David
>
>
-- 

FromDual - Neutral and vendor independent MariaDB, MySQL and PostgreSQL services.

FromDual GmbH                     Rebenweg 6
CH - 8610 Uster
Oli Sennhauser                    CEO / Senior Consultant
Phone: +41 44 500 58 20           Mobile: +41 79 830 09 33
oli.sennhauser@fromdual.com       https://www.fromdual.com
Twitter: fromdual



Attachments:

  [application/pgp-keys] OpenPGP_0xB58CF11D3C9DDEA9.asc (1.7K, ../../f34d2808-df3d-4873-b446-9b40ae22d6ae@fromdual.com/3-OpenPGP_0xB58CF11D3C9DDEA9.asc)
  download

  [application/pgp-signature] OpenPGP_signature.asc (494B, ../../f34d2808-df3d-4873-b446-9b40ae22d6ae@fromdual.com/4-OpenPGP_signature.asc)
  download

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

* Re: Little formatting issues in doc
@ 2026-09-29 18:54  Daniel Gustafsson <daniel@yesql.se>
  parent: Oli Sennhauser <oli.sennhauser@fromdual.com>
  0 siblings, 0 replies; 5+ messages in thread

From: Daniel Gustafsson @ 2026-09-29 18:54 UTC (permalink / raw)
  To: Oli Sennhauser <oli.sennhauser@fromdual.com>; +Cc: David Rowley <dgrowleyml@gmail.com>; pgsql-docs@lists.postgresql.org

> On 29 Sep 2026, at 17:34, Oli Sennhauser <oli.sennhauser@fromdual.com> wrote:

> Question: How frequently is the documentation built and published?
> From the HTML code I can see something like this:
> <meta property="article:published_time" content="2026-08-13T12:52:54.741344" />
> which looks like: "Not daily".

The devel branch documentation is built daily, but for the backbranches the
documentation is built once per release and reflects the documentation at the
time of the release.

--
Daniel Gustafsson







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


end of thread, other threads:[~2026-09-29 18:54 UTC | newest]

Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-09-29 09:20 Little formatting issues in doc Oli Sennhauser <oli.sennhauser@fromdual.com>
2026-09-29 12:56 ` Daniel Gustafsson <daniel@yesql.se>
2026-09-29 13:24   ` David Rowley <dgrowleyml@gmail.com>
2026-09-29 15:34     ` Oli Sennhauser <oli.sennhauser@fromdual.com>
2026-09-29 18:54       ` 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