]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: document libpq 17 cancellation API
authorDenis Laxalde <denis.laxalde@dalibo.com>
Tue, 2 Apr 2024 09:41:42 +0000 (11:41 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Tue, 2 Jul 2024 09:08:17 +0000 (11:08 +0200)
docs/api/pq.rst

index 82922ef25317e84813d9040cc4387a0981ddf9a9..1817fd89574300b96fbf9099ec2c77bc6beabb12 100644 (file)
@@ -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