]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
Fix doc for Notify
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Mon, 27 Sep 2021 09:23:26 +0000 (11:23 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Mon, 27 Sep 2021 09:23:26 +0000 (11:23 +0200)
Probably autoclass is confused by the class module being changed.

docs/api/connections.rst

index 8c9e6a379b7d867d129bef78c333a9863c9a1401..f132c642019ac9f102ab863e8ae827e607a20c79 100644 (file)
@@ -334,10 +334,24 @@ Connection support objects
 --------------------------
 
 .. autoclass:: Notify()
-    :members: channel, payload, pid
 
     The object is usually returned by `Connection.notifies()`.
 
+    .. attribute:: channel
+        :type: str
+
+        The name of the channel on which the notification was received.
+
+    .. attribute:: payload
+        :type: str
+
+        The message attached to the notification.
+
+    .. attribute:: pid
+        :type: int
+
+        The PID of the backend process which sent the notification.
+
 
 .. autoclass:: ConnectionInfo()