From: Denis Laxalde <denis.laxalde@dalibo.com>
Date: Tue, 2 Apr 2024 09:41:42 +0000 (+0200)
Subject: docs: document libpq 17 cancellation API
X-Git-Tag: 3.2.2~16^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=96ba368078e90fa98cf573181047467ec8075c5e;p=thirdparty%2Fpsycopg.git

docs: document libpq 17 cancellation API
---

diff --git a/docs/api/pq.rst b/docs/api/pq.rst
index 82922ef25..1817fd895 100644
--- a/docs/api/pq.rst
+++ b/docs/api/pq.rst
@@ -87,6 +87,7 @@ Objects wrapping libpq structures and functions
 .. autoclass:: PGconn()
 
     .. autoattribute:: pgconn_ptr
+    .. automethod:: cancel_conn
     .. automethod:: get_cancel
     .. autoattribute:: needs_password
     .. autoattribute:: used_password
@@ -137,9 +138,11 @@ Objects wrapping libpq structures and functions
 .. autoclass:: Conninfo
 .. autoclass:: Escaping
 
-.. autoclass:: PGcancel()
+.. autoclass:: PGcancelConn()
     :members:
 
+.. autoclass:: PGcancel()
+    :members:
 
 Enumerations
 ------------
@@ -152,7 +155,7 @@ Enumerations
     during the connection phase and are considered internal.
     `ALLOCATED` is only expected to be returned by `PGcancelConn.status`.
 
-    .. seealso:: :pq:`PQstatus()` and `PQcancelStatus()` return this value.
+    .. seealso:: :pq:`PQstatus()` and :pq:`PQcancelStatus()` return this value.
 
 
 .. autoclass:: PollingStatus