Small documentation improvement for ALTER SUBSCRIPTION

From: Masahiko Sawada <sawada(dot)mshk(at)gmail(dot)com>
To: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Small documentation improvement for ALTER SUBSCRIPTION
Date: 2021-07-08 13:00:18
Message-ID: CAD21AoCm1wJ3A8Q9EmBjRbShYkJ+o+Oa_z9O0hvwhvhUa2BSyg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi all,

When reading the doc of ALTER SUBSCRIPTION I realized that 'refresh
options' in the following paragraph is not tagged:

---
Additionally, refresh options as described under REFRESH PUBLICATION
may be specified, except in the case of DROP PUBLICATION.
---

When I read it for the first time, I got confused because we actually
have the 'refresh' option and this description in the paragraph of the
'refresh' option. I think we can improve it by changing to
'<replaceable>refresh_option</replaceable>'. Thoughts?

The patch is attached.

Regards,

--
Masahiko Sawada
EDB: https://www.enterprisedb.com/

Attachment Content-Type Size
alter_subscription_doc.patch application/octet-stream 653 bytes

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 2021-07-08 13:08:03 Re: visibility map corruption
Previous Message David Rowley 2021-07-08 12:49:37 Re: [PATCH] expand the units that pg_size_pretty supports on output